tccli 3.0.1246.1__py2.py3-none-any.whl → 3.0.1248.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/aca/v20210323/api.json +9 -9
- tccli/services/autoscaling/v20180419/api.json +11 -0
- tccli/services/bh/v20230418/api.json +2 -2
- tccli/services/billing/v20180709/api.json +55 -1
- tccli/services/cam/v20190116/api.json +14 -14
- tccli/services/ccc/v20200210/api.json +61 -1
- tccli/services/clb/v20180317/api.json +29 -1
- tccli/services/clb/v20180317/examples.json +2 -2
- tccli/services/cloudapp/v20220530/api.json +43 -12
- tccli/services/cloudapp/v20220530/examples.json +1 -1
- tccli/services/cls/v20201016/api.json +20 -10
- tccli/services/cls/v20201016/examples.json +4 -4
- tccli/services/cynosdb/v20190107/api.json +64 -0
- tccli/services/cynosdb/v20190107/examples.json +1 -1
- tccli/services/dbbrain/v20210527/api.json +14 -5
- tccli/services/dc/v20180410/api.json +202 -171
- tccli/services/drm/v20181115/api.json +18 -7
- tccli/services/dts/v20211206/api.json +37 -1
- tccli/services/ecm/v20190719/api.json +17 -11
- tccli/services/ecm/v20190719/examples.json +1 -1
- tccli/services/emr/v20190103/api.json +639 -514
- tccli/services/emr/v20190103/examples.json +10 -10
- tccli/services/ess/v20201111/api.json +23 -4
- tccli/services/essbasic/v20210526/api.json +22 -3
- tccli/services/gaap/v20180529/api.json +12 -11
- tccli/services/gaap/v20180529/examples.json +2 -8
- tccli/services/gme/v20180711/api.json +110 -100
- tccli/services/gme/v20180711/examples.json +2 -2
- tccli/services/gwlb/v20240906/api.json +1 -1
- tccli/services/hai/hai_client.py +61 -8
- tccli/services/hai/v20230812/api.json +64 -2
- tccli/services/hai/v20230812/examples.json +10 -2
- tccli/services/hunyuan/v20230901/api.json +4 -4
- tccli/services/keewidb/v20220308/api.json +17 -17
- tccli/services/lcic/v20220817/api.json +111 -112
- tccli/services/lcic/v20220817/examples.json +40 -40
- tccli/services/lkeap/lkeap_client.py +53 -0
- tccli/services/lkeap/v20240522/api.json +91 -0
- tccli/services/lkeap/v20240522/examples.json +9 -1
- tccli/services/mongodb/v20180408/api.json +121 -78
- tccli/services/mongodb/v20180408/examples.json +5 -5
- tccli/services/mongodb/v20190725/api.json +234 -204
- tccli/services/mongodb/v20190725/examples.json +8 -8
- tccli/services/ocr/v20181119/api.json +17 -17
- tccli/services/ocr/v20181119/examples.json +15 -15
- tccli/services/postgres/postgres_client.py +106 -0
- tccli/services/postgres/v20170312/api.json +135 -0
- tccli/services/postgres/v20170312/examples.json +16 -0
- tccli/services/redis/v20180412/api.json +11 -11
- tccli/services/scf/v20180416/api.json +2 -2
- tccli/services/ssl/v20191205/api.json +7 -7
- tccli/services/ssl/v20191205/examples.json +71 -5
- tccli/services/tcb/v20180608/api.json +930 -719
- tccli/services/tcb/v20180608/examples.json +22 -22
- tccli/services/tcbr/v20220217/api.json +46 -13
- tccli/services/tcbr/v20220217/examples.json +2 -8
- tccli/services/tcr/v20190924/api.json +83 -78
- tccli/services/tcr/v20190924/examples.json +44 -44
- tccli/services/tdmq/tdmq_client.py +57 -4
- tccli/services/tdmq/v20200217/api.json +107 -0
- tccli/services/tdmq/v20200217/examples.json +8 -0
- tccli/services/tione/v20211111/api.json +23 -3
- tccli/services/trtc/v20190722/api.json +84 -82
- tccli/services/trtc/v20190722/examples.json +2 -2
- tccli/services/vdb/v20230616/api.json +2 -2
- tccli/services/vpc/v20170312/api.json +56 -33
- tccli/services/vpc/v20170312/examples.json +10 -10
- {tccli-3.0.1246.1.dist-info → tccli-3.0.1248.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1246.1.dist-info → tccli-3.0.1248.1.dist-info}/RECORD +73 -73
- {tccli-3.0.1246.1.dist-info → tccli-3.0.1248.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1246.1.dist-info → tccli-3.0.1248.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1246.1.dist-info → tccli-3.0.1248.1.dist-info}/license_files/LICENSE +0 -0
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
"AddNodeResourceConfig": [
|
|
12
12
|
{
|
|
13
13
|
"document": "",
|
|
14
|
-
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AddNodeResourceConfig\n<公共请求参数>\n\n{\n \"
|
|
14
|
+
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AddNodeResourceConfig\n<公共请求参数>\n\n{\n \"HardwareResourceType\": \"HOST\",\n \"InstanceId\": \"emr-llp6c58v\",\n \"PayMode\": 0,\n \"ResourceConfig\": {\n \"Cpu\": 4,\n \"DiskSize\": 0,\n \"DiskType\": \"CLOULD_SSD\",\n \"InstanceType\": \"SA5.LARGE16\",\n \"MemSize\": 16384,\n \"MultiDisks\": [],\n \"Spec\": \"SA5\",\n \"StorageType\": 0\n },\n \"ResourceType\": \"TASK\",\n \"ZoneId\": 100007\n}",
|
|
15
15
|
"output": "{\n \"Response\": {\n \"RequestId\": \"f0f11d21-6d0d-4f73-9177-8ae4ec456068\"\n }\n}",
|
|
16
16
|
"title": "增加当前集群的节点规格配置"
|
|
17
17
|
}
|
|
@@ -75,9 +75,9 @@
|
|
|
75
75
|
"DeleteNodeResourceConfig": [
|
|
76
76
|
{
|
|
77
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\": \"
|
|
78
|
+
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DeleteNodeResourceConfig\n<公共请求参数>\n\n{\n \"InstanceId\": \"emr-da13dada\",\n \"ResourceType\": \"CORE\",\n \"ResourceConfigId\": 1,\n \"ResourceBaseType\": \"EMR\"\n}",
|
|
79
79
|
"output": "{\n \"Response\": {\n \"RequestId\": \"8c2ff02e-5f38-494a-8d2d-68a7dec6efcd\"\n }\n}",
|
|
80
|
-
"title": "
|
|
80
|
+
"title": "删除当前集群的节点规格配置"
|
|
81
81
|
}
|
|
82
82
|
],
|
|
83
83
|
"DeleteUserManagerUserList": [
|
|
@@ -316,7 +316,7 @@
|
|
|
316
316
|
{
|
|
317
317
|
"document": "",
|
|
318
318
|
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeStarrocksQueryInfo\n<公共请求参数>\n\n{\n \"InstanceId\": \"emr-1qop4l3e\",\n \"PageSize\": 10,\n \"Page\": 1,\n \"StartTime\": 1722327682,\n \"EndTime\": 1722328091\n}",
|
|
319
|
-
"output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"StarRocksQueryInfoList\": [\n {\n \"ClientIP\": \"192.0.0.1\",\n \"CPUCost\": 0,\n \"DefaultDB\": \"
|
|
319
|
+
"output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"StarRocksQueryInfoList\": [\n {\n \"ClientIP\": \"192.0.0.1\",\n \"CPUCost\": 0,\n \"DefaultDB\": \"db_test\",\n \"EndTime\": 1721962352,\n \"ExecutionIP\": \"192.0.0.1\",\n \"QueryID\": \"1ac25f6c-4afa-11ef-b7cc-525400c756d2\",\n \"QueryType\": \"OTHERS\",\n \"MemCost\": 324,\n \"PlanCpuCosts\": 435620,\n \"PlanMemCosts\": 254354,\n \"QueryTime\": 345535,\n \"ResourceGroup\": \"SR\",\n \"ReturnRows\": 2452,\n \"ScanBytes\": 1235124,\n \"ScanRows\": 123512,\n \"BeginTime\": 1721962352,\n \"ExecutionState\": \"FINISHED\",\n \"ExecutionStatement\": \"show compute nodes\",\n \"User\": \"test_aa\"\n }\n ],\n \"RequestId\": \"1ac25f6c-4afa-11ef-b7cc-525400454wfaa1\"\n }\n}",
|
|
320
320
|
"title": "DescribeStarRocksQueryInfo"
|
|
321
321
|
}
|
|
322
322
|
],
|
|
@@ -427,8 +427,8 @@
|
|
|
427
427
|
"ModifyInstanceBasic": [
|
|
428
428
|
{
|
|
429
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\": \"
|
|
431
|
-
"output": "{\n \"Response\": {\n \"RequestId\": \"
|
|
430
|
+
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyInstanceBasic\n<公共请求参数>\n\n{\n \"InstanceId\": \"emr-sfaddfda\",\n \"ClusterName\": \"emr-test\",\n \"ResourceBaseType\": \"EMR\"\n}",
|
|
431
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"b8d3e1eb-5730-4f6b-8d4d-bb4aabf99069 \"\n }\n}",
|
|
432
432
|
"title": "ModifyInstanceBasic"
|
|
433
433
|
}
|
|
434
434
|
],
|
|
@@ -436,7 +436,7 @@
|
|
|
436
436
|
{
|
|
437
437
|
"document": "调整容器集群Pod数量",
|
|
438
438
|
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyPodNum\n<公共请求参数>\n\n{\n \"InstanceId\": \"emr-ikoyp9nw\",\n \"ServiceGroup\": 44,\n \"ServiceType\": 93,\n \"PodNum\": 3\n}",
|
|
439
|
-
"output": "{\n \"Response\": {\n \"InstanceId\": \"emr-ikoyp9nw\",\n \"FlowId\": 0,\n \"RequestId\": \"
|
|
439
|
+
"output": "{\n \"Response\": {\n \"InstanceId\": \"emr-ikoyp9nw\",\n \"FlowId\": 0,\n \"RequestId\": \"fe127236-3646-4676-80ae-a491b596fedd\"\n }\n}",
|
|
440
440
|
"title": "调整容器集群Pod数量"
|
|
441
441
|
}
|
|
442
442
|
],
|
|
@@ -452,7 +452,7 @@
|
|
|
452
452
|
{
|
|
453
453
|
"document": "",
|
|
454
454
|
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyResourcePools\n<公共请求参数>\n\n{\n \"InstanceId\": \"emr-2xef56\",\n \"Key\": \"fair\"\n}",
|
|
455
|
-
"output": "{\n \"Response\": {\n \"IsDraft\": true,\n \"ErrorMsg\":
|
|
455
|
+
"output": "{\n \"Response\": {\n \"IsDraft\": true,\n \"ErrorMsg\": \"errormsg_test\",\n \"RequestId\": \"61fb757e-5a86-41ab-8421-b3abc7aff683\"\n }\n}",
|
|
456
456
|
"title": "test"
|
|
457
457
|
}
|
|
458
458
|
],
|
|
@@ -460,7 +460,7 @@
|
|
|
460
460
|
{
|
|
461
461
|
"document": "",
|
|
462
462
|
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyResourceScheduleConfig\n<公共请求参数>\n\n{\n \"InstanceId\": \"emr-buy439fq\",\n \"Key\": \"capacity\",\n \"Value\": \"{\\\"queueMappings\\\":[{\\\"mapping-type\\\":\\\"u\\\",\\\"name\\\":\\\"1331\\\",\\\"full-queue-name\\\":\\\"132\\\",\\\"special-name\\\":true,\\\"special-queue\\\":true}],\\\"queue\\\":{\\\"name\\\":\\\"root\\\",\\\"capacity\\\":100,\\\"maximum-capacity\\\":100,\\\"minimum-user-limit-percent\\\":0,\\\"user-limit-factor\\\":0,\\\"maximum-allocation-mb\\\":0,\\\"maximum-allocation-vcores\\\":0,\\\"state\\\":null,\\\"maximum-applications\\\":0,\\\"maximum-am-resource-percent\\\":0,\\\"acl_submit_applications\\\":null,\\\"acl_administer_queue\\\":null,\\\"queues\\\":[{\\\"name\\\":\\\"121\\\",\\\"capacity\\\":12,\\\"maximum-capacity\\\":12,\\\"minimum-user-limit-percent\\\":12,\\\"user-limit-factor\\\":12,\\\"maximum-allocation-mb\\\":12,\\\"maximum-allocation-vcores\\\":12,\\\"state\\\":\\\"RUNNING\\\",\\\"maximum-applications\\\":10000,\\\"maximum-am-resource-percent\\\":25,\\\"acl_submit_applications\\\":{\\\"user\\\":\\\"*\\\",\\\"group\\\":\\\"*\\\"},\\\"acl_administer_queue\\\":{\\\"user\\\":\\\"*\\\",\\\"group\\\":\\\"*\\\"},\\\"queues\\\":null},{\\\"name\\\":\\\"12\\\",\\\"capacity\\\":12,\\\"maximum-capacity\\\":12,\\\"minimum-user-limit-percent\\\":12,\\\"user-limit-factor\\\":12,\\\"maximum-allocation-mb\\\":12,\\\"maximum-allocation-vcores\\\":12,\\\"state\\\":\\\"RUNNING\\\",\\\"maximum-applications\\\":10000,\\\"maximum-am-resource-percent\\\":25,\\\"acl_submit_applications\\\":{\\\"user\\\":\\\"*\\\",\\\"group\\\":\\\"*\\\"},\\\"acl_administer_queue\\\":{\\\"user\\\":\\\"*\\\",\\\"group\\\":\\\"*\\\"},\\\"queues\\\":null},{\\\"name\\\":\\\"default\\\",\\\"capacity\\\":76,\\\"maximum-capacity\\\":100,\\\"minimum-user-limit-percent\\\":12,\\\"user-limit-factor\\\":1,\\\"maximum-allocation-mb\\\":12,\\\"maximum-allocation-vcores\\\":12,\\\"state\\\":\\\"RUNNING\\\",\\\"maximum-applications\\\":12,\\\"maximum-am-resource-percent\\\":12,\\\"acl_submit_applications\\\":{\\\"user\\\":\\\"*\\\",\\\"group\\\":\\\"*\\\"},\\\"acl_administer_queue\\\":{\\\"user\\\":\\\"*\\\",\\\"group\\\":\\\"*\\\"},\\\"queues\\\":[{\\\"name\\\":\\\"d1\\\",\\\"capacity\\\":100,\\\"maximum-capacity\\\":100,\\\"minimum-user-limit-percent\\\":null,\\\"user-limit-factor\\\":null,\\\"maximum-allocation-mb\\\":null,\\\"maximum-allocation-vcores\\\":null,\\\"state\\\":\\\"RUNNING\\\",\\\"maximum-applications\\\":10000,\\\"maximum-am-resource-percent\\\":25,\\\"acl_submit_applications\\\":{\\\"user\\\":\\\"*\\\",\\\"group\\\":\\\"*\\\"},\\\"acl_administer_queue\\\":{\\\"user\\\":\\\"*\\\",\\\"group\\\":\\\"*\\\"},\\\"queues\\\":null}]}]},\\\"queueMappingsOverride\\\":true}\"\n}",
|
|
463
|
-
"output": "{\n \"Response\": {\n \"IsDraft\": true,\n \"ErrorMsg\":
|
|
463
|
+
"output": "{\n \"Response\": {\n \"IsDraft\": true,\n \"ErrorMsg\": \"ErrorMsg_test\",\n \"Data\": \"json\",\n \"RequestId\": \"61fb757e-5a86-41ab-8421-b3abc7aff683\"\n }\n}",
|
|
464
464
|
"title": "修改yarn资源调度的资源配置"
|
|
465
465
|
}
|
|
466
466
|
],
|
|
@@ -555,7 +555,7 @@
|
|
|
555
555
|
"SetNodeResourceConfigDefault": [
|
|
556
556
|
{
|
|
557
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\": \"
|
|
558
|
+
"input": "POST / HTTP/1.1\nHost: emr.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: SetNodeResourceConfigDefault\n<公共请求参数>\n\n{\n \"InstanceId\": \"emr-fdadad\",\n \"ResourceType\": \"CORE\",\n \"ResourceConfigId\": 1,\n \"ResourceBaseType\": \"EMR\"\n}",
|
|
559
559
|
"output": "{\n \"Response\": {\n \"RequestId\": \"8c2ff02e-5f38-494a-8d2d-68a7dec6efcd\"\n }\n}",
|
|
560
560
|
"title": "输出输入参数"
|
|
561
561
|
}
|
|
@@ -2078,7 +2078,7 @@
|
|
|
2078
2078
|
},
|
|
2079
2079
|
{
|
|
2080
2080
|
"disabled": false,
|
|
2081
|
-
"document": "**在所有的定位方式下**，控件的扩展参数，为<font color=\"red\">JSON格式</font>，不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围12 :72</li>\n<li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围12 :72</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为WATERMARK时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围6 :24</li>\n<li> <b>Opacity</b>： 透明度，范围0 :1</li>\n<li> <b>Density</b>： 水印样式，1-宽松，2-标准（默认值），3-密集，</li>\n<li> <b>SubType</b>： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息</li></ul>\n<b>参数样例</b>：`\"{\\\"Font\\\":\\\"黑体\\\",\\\"FontSize\\\":20,\\\"Opacity\\\":0.1,\\\"Density\\\":2,\\\"SubType\\\":\\\"PERSON_INFO_WATERMARK\\\"}\"`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>，支持以下参数：\n<ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE类型时</font>，可以通过**ComponentTypeLimit**参数控制签名方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>：`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n<br><br>\n\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li></ul>\n<b>参考样例</b>：`{\\\"ComponentTypeLimit\\\":[\\\"PERSONNEL\\\",\\\"FINANCE\\\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\"，如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型，范围6-72，默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期\n特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）\n<b>参数样例</b>： ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL类型时</font>，支持以下参数：\n<ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul>\n<b>参数样例</b>：` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章透明度功能设置，</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：\n<ul><li> <b>Opacity</b>：印章透明度，支持范围：0.6-1，0.7表示70%的透明度，1表示无透明度</li></ul>\n<b>参数样例</b>：`{\"Opacity\":0.7}`\n\n<font color=\"red\">签署印章大小功能设置，</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：\n<ul><li> <b>UseSealSize</b>：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false</li></ul>\n<b>参数样例</b>：`{\"UseSealSize\":true}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置\"IgnoreKeywordError\"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。\n<b>参数样例</b>：` \"{\"IgnoreKeywordError\":1}\"`\n\n<font color=\"red\">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>，支持以下参数：\n<ul>\n<li><b>Children:</b> 绝对定位模式下，用来指定此签批控件的组合子控件 </li>\n<b>参数样例</b>：<br>`{\"Children\":[\"ComponentId_29\",\"ComponentId_27\",\"ComponentId_28\",\"ComponentId_30\"]}`\n<li><b>ChildrenComponents:</b> 关键字定位模式下，用来指定此签批控件的组合子控件 </li>\nChildrenComponent结构体定义:\n<table border=\"1\"
|
|
2081
|
+
"document": "**在所有的定位方式下**，控件的扩展参数，为<font color=\"red\">JSON格式</font>，不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围12 :72</li>\n<li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围12 :72</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为WATERMARK时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围6 :24</li>\n<li> <b>Opacity</b>： 透明度，范围0 :1</li>\n<li> <b>Density</b>： 水印样式，1-宽松，2-标准（默认值），3-密集，</li>\n<li> <b>SubType</b>： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息</li></ul>\n<b>参数样例</b>：`\"{\\\"Font\\\":\\\"黑体\\\",\\\"FontSize\\\":20,\\\"Opacity\\\":0.1,\\\"Density\\\":2,\\\"SubType\\\":\\\"PERSON_INFO_WATERMARK\\\"}\"`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>，支持以下参数：\n<ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE类型时</font>，可以通过**ComponentTypeLimit**参数控制签名方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>：`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n<br><br>\n\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li></ul>\n<b>参考样例</b>：`{\\\"ComponentTypeLimit\\\":[\\\"PERSONNEL\\\",\\\"FINANCE\\\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\"，如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型，范围6-72，默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期\n特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）\n<b>参数样例</b>： ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL类型时</font>，支持以下参数：\n<ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul>\n<b>参数样例</b>：` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章透明度功能设置，</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：\n<ul><li> <b>Opacity</b>：印章透明度，支持范围：0.6-1，0.7表示70%的透明度，1表示无透明度</li></ul>\n<b>参数样例</b>：`{\"Opacity\":0.7}`\n\n<font color=\"red\">签署印章大小功能设置，</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：\n<ul><li> <b>UseSealSize</b>：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false</li></ul>\n<b>参数样例</b>：`{\"UseSealSize\":true}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置\"IgnoreKeywordError\"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。\n<b>参数样例</b>：` \"{\"IgnoreKeywordError\":1}\"`\n\n<font color=\"red\">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>，支持以下参数：\n<ul>\n<li><b>Children:</b> 绝对定位模式下，用来指定此签批控件的组合子控件 </li>\n<b>参数样例</b>：<br>`{\"Children\":[\"ComponentId_29\",\"ComponentId_27\",\"ComponentId_28\",\"ComponentId_30\"]}`\n<li><b>ChildrenComponents:</b> 关键字定位模式下，用来指定此签批控件的组合子控件 </li>\nChildrenComponent结构体定义:\n<table border=\"1\"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语</td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X（相对于父控件（签批控件的ComponentX））</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件（签批控件的ComponentY））</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息，根据ComponentType设置</td> </tr> </tbody> </table>\n<b>参数样例</b>：\n \n输入:\n<pre>\n{\n ChildrenComponents: [\n {\n ComponentType: SIGN_SIGNATURE,\n ComponentName: 个人签名,\n Placeholder: 请签名,\n ComponentOffsetX: 10,\n ComponentOffsetY: 30,\n ComponentWidth: 119,\n ComponentHeight: 43,\n ComponentExtra: {\\ComponentTypeLimit\\:[\\SYSTEM_ESIGN\\]}\n },\n {\n ComponentType: SIGN_SELECTOR,\n ComponentName: 是否同意此协议,\n Placeholder: ,\n ComponentOffsetX: 50,\n ComponentOffsetY: 130,\n ComponentWidth: 120,\n ComponentHeight: 43,\n ComponentExtra: {\\Values\\:[\\同意\\,\\不同意\\,\\再想想\\],\\FontSize\\:12,\\FontAlign\\:\\Left\\,\\Font\\:\\黑体\\,\\MultiSelect\\:false}\n },\n {\n ComponentType: SIGN_MULTI_LINE_TEXT,\n ComponentName: 批注附言,\n Placeholder: ,\n ComponentOffsetX: 150,\n ComponentOffsetY: 300,\n ComponentWidth: 200,\n ComponentHeight: 86,\n ComponentExtra: \n }\n ]\n}\n</pre>\n</ul>\n\n",
|
|
2082
2082
|
"example": "无",
|
|
2083
2083
|
"member": "string",
|
|
2084
2084
|
"name": "ComponentExtra",
|
|
@@ -10888,7 +10888,7 @@
|
|
|
10888
10888
|
"value_allowed_null": false
|
|
10889
10889
|
},
|
|
10890
10890
|
{
|
|
10891
|
-
"disabled":
|
|
10891
|
+
"disabled": true,
|
|
10892
10892
|
"document": "模板配置中的参与方ID,与控件绑定",
|
|
10893
10893
|
"example": "无",
|
|
10894
10894
|
"member": "string",
|
|
@@ -11006,6 +11006,16 @@
|
|
|
11006
11006
|
"output_required": false,
|
|
11007
11007
|
"type": "string",
|
|
11008
11008
|
"value_allowed_null": true
|
|
11009
|
+
},
|
|
11010
|
+
{
|
|
11011
|
+
"disabled": false,
|
|
11012
|
+
"document": "模板配置中的参与方ID,与控件绑定",
|
|
11013
|
+
"example": "无",
|
|
11014
|
+
"member": "string",
|
|
11015
|
+
"name": "RecipientId",
|
|
11016
|
+
"output_required": true,
|
|
11017
|
+
"type": "string",
|
|
11018
|
+
"value_allowed_null": false
|
|
11009
11019
|
}
|
|
11010
11020
|
],
|
|
11011
11021
|
"usage": "out"
|
|
@@ -13989,12 +13999,12 @@
|
|
|
13989
13999
|
"type": "string"
|
|
13990
14000
|
},
|
|
13991
14001
|
{
|
|
13992
|
-
"disabled":
|
|
14002
|
+
"disabled": true,
|
|
13993
14003
|
"document": "要更换的原合同参与人RecipientId编号。(可通过接口<a href=\"https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/\">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>",
|
|
13994
14004
|
"example": "无",
|
|
13995
14005
|
"member": "string",
|
|
13996
14006
|
"name": "RelievedApproverReceiptId",
|
|
13997
|
-
"required":
|
|
14007
|
+
"required": false,
|
|
13998
14008
|
"type": "string"
|
|
13999
14009
|
},
|
|
14000
14010
|
{
|
|
@@ -14032,6 +14042,15 @@
|
|
|
14032
14042
|
"name": "ApproverSignSealId",
|
|
14033
14043
|
"required": false,
|
|
14034
14044
|
"type": "string"
|
|
14045
|
+
},
|
|
14046
|
+
{
|
|
14047
|
+
"disabled": false,
|
|
14048
|
+
"document": "要更换的原合同参与人RecipientId编号。(可通过接口<a href=\"https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/\">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>",
|
|
14049
|
+
"example": "无",
|
|
14050
|
+
"member": "string",
|
|
14051
|
+
"name": "RelievedApproverRecipientId",
|
|
14052
|
+
"required": false,
|
|
14053
|
+
"type": "string"
|
|
14035
14054
|
}
|
|
14036
14055
|
],
|
|
14037
14056
|
"usage": "in"
|
|
@@ -2591,13 +2591,22 @@
|
|
|
2591
2591
|
"type": "int"
|
|
2592
2592
|
},
|
|
2593
2593
|
{
|
|
2594
|
-
"disabled":
|
|
2594
|
+
"disabled": true,
|
|
2595
2595
|
"document": "是否开启动态合同（动态签署人2.0）\n<ul><li> **false** :(默认) 不开启动态合同（动态签署人2.0）</li>\n<li> **true** :开启动态合同（动态签署人2.0）,发起后可继续追加合同签署人</li></ul>\n",
|
|
2596
2596
|
"example": "false",
|
|
2597
2597
|
"member": "bool",
|
|
2598
2598
|
"name": "OpenDynamicFlow",
|
|
2599
2599
|
"required": false,
|
|
2600
2600
|
"type": "bool"
|
|
2601
|
+
},
|
|
2602
|
+
{
|
|
2603
|
+
"disabled": false,
|
|
2604
|
+
"document": "是否开启动态合同（动态签署人2.0）<ul><li> **false** :(默认) 不开启动态合同（动态签署人2.0）</li><li> **true** :开启动态合同（动态签署人2.0）,发起后可继续追加合同签署人</li></ul>",
|
|
2605
|
+
"example": "false",
|
|
2606
|
+
"member": "bool",
|
|
2607
|
+
"name": "OpenDynamicSignFlow",
|
|
2608
|
+
"required": false,
|
|
2609
|
+
"type": "bool"
|
|
2601
2610
|
}
|
|
2602
2611
|
],
|
|
2603
2612
|
"type": "object"
|
|
@@ -6076,7 +6085,7 @@
|
|
|
6076
6085
|
},
|
|
6077
6086
|
{
|
|
6078
6087
|
"disabled": false,
|
|
6079
|
-
"document": "**在所有的定位方式下**，控件的扩展参数，为<font color=\"red\">JSON格式</font>，不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围12 :72</li>\n<li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围12 :72</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>，支持以下参数：\n<ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE类型时</font>，可以**ComponentTypeLimit**参数控制签署方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>：`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n<br><br>\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li></ul>\n<b>参考样例</b>：`{\\\"ComponentTypeLimit\\\":[\\\"PERSONNEL\\\",\\\"FINANCE\\\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\"，如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型，范围6-72，默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期\n特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）\n<b>参数样例</b>： ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL类型时</font>，支持以下参数：\n<ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul>\n<b>参数样例</b>：` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时</font>，可以通过以下参数设置签署图片的旋转角度：\n<ul><li> <b>Rotate</b>：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。</li>\n<li> <b>RotateRelation</b>：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。</li></ul>\n<b>参数样例</b>：`{\"Rotate\":-30,\"RotateRelation\":\"Component_Id1\"}`\n\n<font color=\"red\">签署印章透明度功能设置，</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：\n<ul><li> <b>Opacity</b>：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度</li></ul>\n<b>参数样例</b>：`{\"Opacity\":0.7}`\n\n<font color=\"red\">签署印章大小功能设置，</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：\n<ul><li> <b>UseSealSize</b>：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false</li></ul>\n<b>参数样例</b>：`{\"UseSealSize\":true}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置\"IgnoreKeywordError\"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。\n<b>参数样例</b>：` \"{\"IgnoreKeywordError\":1}\"`\n\n\n<font color=\"red\">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>，支持以下参数：\n<ul>\n<li><b>Children:</b> 绝对定位模式下，用来指定此签批控件的组合子控件 </li>\n<b>参数样例</b>：<br>`{\"Children\":[\"ComponentId_29\",\"ComponentId_27\",\"ComponentId_28\",\"ComponentId_30\"]}`\n<li><b>ChildrenComponents:</b> 关键字定位模式下，用来指定此签批控件的组合子控件 </li>\nChildrenComponent结构体定义:\n<table border=\"1\"
|
|
6088
|
+
"document": "**在所有的定位方式下**，控件的扩展参数，为<font color=\"red\">JSON格式</font>，不同类型的控件会有部分非通用参数。\n\n<font color=\"red\">ComponentType为TEXT、MULTI_LINE_TEXT时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围12 :72</li>\n<li> <b>FontAlign</b>： Left/Right/Center，左对齐/居中/右对齐</li>\n<li> <b>FontColor</b>：字符串类型，格式为RGB颜色数字</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b>：目前只支持黑体、宋体</li>\n<li> <b>FontSize</b>： 范围12 :72</li></ul>\n<b>参数样例</b>：`{\"FontColor\":\"255,0,0\",\"FontSize\":12}`\n\n<font color=\"red\">ComponentType为FILL_IMAGE时</font>，支持以下参数：\n<ul><li> <b>NotMakeImageCenter</b>：bool。是否设置图片居中。false：居中（默认）。 true : 不居中</li>\n<li> <b>FillMethod</b> : int. 填充方式。0-铺满（默认）；1-等比例缩放</li></ul>\n\n<font color=\"red\">ComponentType为SIGN_SIGNATURE类型时</font>，可以**ComponentTypeLimit**参数控制签署方式\n<ul><li> <b>HANDWRITE</b> : 需要实时手写的手写签名</li>\n<li> <b>HANDWRITTEN_ESIGN</b> : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)</li>\n<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>\n<li> <b>ESIGN</b> : 个人印章类型</li>\n<li> <b>SYSTEM_ESIGN</b> : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）</li>\n<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>\n<b>参考样例</b>：`{\"ComponentTypeLimit\": [\"SYSTEM_ESIGN\"]}`\n印章的对应关系参考下图\n<br><br>\n<font color=\"red\">ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时</font>，可以通过**ComponentTypeLimit**参数控制签署方签署时要使用的印章类型，支持指定以下印章类型\n<ul><li> <b>OFFICIAL</b> : 企业公章</li>\n<li> <b>CONTRACT</b> : 合同专用章</li>\n<li> <b>FINANCE</b> : 财务专用章</li>\n<li> <b>PERSONNEL</b> : 人事专用章</li></ul>\n<b>参考样例</b>：`{\\\"ComponentTypeLimit\\\":[\\\"PERSONNEL\\\",\\\"FINANCE\\\"]}` 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。<br><br>\n\n<font color=\"red\">ComponentType为SIGN_DATE时</font>，支持以下参数：\n<ul><li> <b>Font</b> :字符串类型目前只支持\"黑体\"、\"宋体\"，如果不填默认为\"黑体\"</li>\n<li> <b>FontSize</b> : 数字类型，范围6-72，默认值为12</li>\n<li> <b>FontAlign</b> : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐</li>\n<li> <b>Format</b> : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。</li>\n<li> <b>Gaps</b> : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>\n如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期\n特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）\n<b>参数样例</b>： ` \"{\"Format\":\"yyyy m d\",\"FontSize\":12,\"Gaps\":\"2,2\", \"FontAlign\":\"Right\"}\"`\n\n<font color=\"red\">ComponentType为SIGN_SEAL类型时</font>，支持以下参数：\n<ul><li> <b>PageRanges</b> :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）</li></ul>\n<b>参数样例</b>：` \"{\"PageRanges\":[{\"BeginPage\":1,\"EndPage\":-1}]}\"`\n\n<font color=\"red\">签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时</font>，可以通过以下参数设置签署图片的旋转角度：\n<ul><li> <b>Rotate</b>：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。</li>\n<li> <b>RotateRelation</b>：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。</li></ul>\n<b>参数样例</b>：`{\"Rotate\":-30,\"RotateRelation\":\"Component_Id1\"}`\n\n<font color=\"red\">签署印章透明度功能设置，</font>当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：\n<ul><li> <b>Opacity</b>：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度</li></ul>\n<b>参数样例</b>：`{\"Opacity\":0.7}`\n\n<font color=\"red\">签署印章大小功能设置，</font>当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：\n<ul><li> <b>UseSealSize</b>：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false</li></ul>\n<b>参数样例</b>：`{\"UseSealSize\":true}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置\"IgnoreKeywordError\"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。\n<b>参数样例</b>：` \"{\"IgnoreKeywordError\":1}\"`\n\n\n<font color=\"red\">ComponentType为SIGN_VIRTUAL_COMBINATION时</font>，支持以下参数：\n<ul>\n<li><b>Children:</b> 绝对定位模式下，用来指定此签批控件的组合子控件 </li>\n<b>参数样例</b>：<br>`{\"Children\":[\"ComponentId_29\",\"ComponentId_27\",\"ComponentId_28\",\"ComponentId_30\"]}`\n<li><b>ChildrenComponents:</b> 关键字定位模式下，用来指定此签批控件的组合子控件 </li>\nChildrenComponent结构体定义:\n<table border=\"1\"> <thead> <tr> <th>字段名称</th> <th>类型</th> <th>描述</th> </tr> </thead> <tbody> <tr> <td>ComponentType</td> <td>string</td> <td>子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT</td> </tr> <tr> <td>ComponentName</td> <td>string</td> <td>子控件名称</td> </tr> <tr> <td>Placeholder</td> <td>string</td> <td>子控件提示语</td> </tr> <tr> <td>ComponentOffsetX</td> <td>float</td> <td>控件偏移位置X（相对于父控件（签批控件的ComponentX））</td> </tr> <tr> <td>ComponentOffsetY</td> <td>float</td> <td>控件偏移位置Y 相对于父控件（签批控件的ComponentY））</td> </tr> <tr> <td>ComponentWidth</td> <td>float</td> <td>控件宽</td> </tr> <tr> <td>ComponentHeight</td> <td>float</td> <td>控件高</td> </tr> <tr> <td>ComponentExtra</td> <td>string</td> <td>控件的附属信息，根据ComponentType设置</td> </tr> </tbody> </table>\n<b>参数样例</b>：\n\n<pre>\n{\n \"ChildrenComponents\": [\n {\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentName\": \"个人签名\",\n \"Placeholder\": \"请签名\",\n \"ComponentOffsetX\": 10,\n \"ComponentOffsetY\": 30,\n \"ComponentWidth\": 119,\n \"ComponentHeight\": 43,\n \"ComponentExtra\": \"{\\\"ComponentTypeLimit\\\":[\\\"SYSTEM_ESIGN\\\"]}\"\n },\n {\n \"ComponentType\": \"SIGN_SELECTOR\",\n \"ComponentName\": \"是否同意此协议\",\n \"Placeholder\": \"\",\n \"ComponentOffsetX\": 50,\n \"ComponentOffsetY\": 130,\n \"ComponentWidth\": 120,\n \"ComponentHeight\": 43,\n \"ComponentExtra\": \"{\\\"Values\\\":[\\\"同意\\\",\\\"不同意\\\",\\\"再想想\\\"],\\\"FontSize\\\":12,\\\"FontAlign\\\":\\\"Left\\\",\\\"Font\\\":\\\"黑体\\\",\\\"MultiSelect\\\":false}\"\n },\n {\n \"ComponentType\": \"SIGN_MULTI_LINE_TEXT\",\n \"ComponentName\": \"批注附言\",\n \"Placeholder\": \"\",\n \"ComponentOffsetX\": 150,\n \"ComponentOffsetY\": 300,\n \"ComponentWidth\": 200,\n \"ComponentHeight\": 86,\n \"ComponentExtra\": \"\"\n }\n ]\n}</pre>\n</ul>\n\n\n\n",
|
|
6080
6089
|
"example": "ComponentExtra",
|
|
6081
6090
|
"member": "string",
|
|
6082
6091
|
"name": "ComponentExtra",
|
|
@@ -9506,7 +9515,7 @@
|
|
|
9506
9515
|
"document": "签署人的流程信息明细",
|
|
9507
9516
|
"members": [
|
|
9508
9517
|
{
|
|
9509
|
-
"disabled":
|
|
9518
|
+
"disabled": true,
|
|
9510
9519
|
"document": "模板配置时候的签署人角色ID(用PDF文件发起也可以指定,如果不指定则自动生成此角色ID), 所有的填写控件和签署控件都归属不同的角色",
|
|
9511
9520
|
"example": "yDRS4UUgygqdcjjdUuO4zjEC0osCOsHS",
|
|
9512
9521
|
"member": "string",
|
|
@@ -9634,6 +9643,16 @@
|
|
|
9634
9643
|
"output_required": false,
|
|
9635
9644
|
"type": "string",
|
|
9636
9645
|
"value_allowed_null": true
|
|
9646
|
+
},
|
|
9647
|
+
{
|
|
9648
|
+
"disabled": false,
|
|
9649
|
+
"document": "模板配置时候的签署人角色ID(用PDF文件发起也可以指定,如果不指定则自动生成此角色ID), 所有的填写控件和签署控件都归属不同的角色",
|
|
9650
|
+
"example": "yDRS4UUgygqdcjjdUuO4zjEC0osCOsHS",
|
|
9651
|
+
"member": "string",
|
|
9652
|
+
"name": "RecipientId",
|
|
9653
|
+
"output_required": true,
|
|
9654
|
+
"type": "string",
|
|
9655
|
+
"value_allowed_null": false
|
|
9637
9656
|
}
|
|
9638
9657
|
],
|
|
9639
9658
|
"usage": "out"
|
|
@@ -85,11 +85,11 @@
|
|
|
85
85
|
"status": "online"
|
|
86
86
|
},
|
|
87
87
|
"CreateFirstLinkSession": {
|
|
88
|
-
"document": "本接口（CreateFirstLinkSession）用于创建接入段加速会话，创建有可能成功，也可能失败，需要通过返回码来进行判断。",
|
|
88
|
+
"document": "产品功能已下线，对应的api接口下线\n\n本接口（CreateFirstLinkSession）用于创建接入段加速会话，创建有可能成功，也可能失败，需要通过返回码来进行判断。",
|
|
89
89
|
"input": "CreateFirstLinkSessionRequest",
|
|
90
90
|
"name": "创建接入段加速会话",
|
|
91
91
|
"output": "CreateFirstLinkSessionResponse",
|
|
92
|
-
"status": "
|
|
92
|
+
"status": "deprecated"
|
|
93
93
|
},
|
|
94
94
|
"CreateGlobalDomain": {
|
|
95
95
|
"document": "用来创建统一域名",
|
|
@@ -197,11 +197,11 @@
|
|
|
197
197
|
"status": "online"
|
|
198
198
|
},
|
|
199
199
|
"DeleteFirstLinkSession": {
|
|
200
|
-
"document": "本接口（DeleteFirstLinkSession）用于删除接入段加速会话，删除加速会话后会停止加速。",
|
|
200
|
+
"document": "产品功能已下线，下线对应的api接口\n\n本接口（DeleteFirstLinkSession）用于删除接入段加速会话，删除加速会话后会停止加速。",
|
|
201
201
|
"input": "DeleteFirstLinkSessionRequest",
|
|
202
202
|
"name": "删除接入段加速会话",
|
|
203
203
|
"output": "DeleteFirstLinkSessionResponse",
|
|
204
|
-
"status": "
|
|
204
|
+
"status": "deprecated"
|
|
205
205
|
},
|
|
206
206
|
"DeleteGlobalDomain": {
|
|
207
207
|
"document": "删除统一域名",
|
|
@@ -337,11 +337,11 @@
|
|
|
337
337
|
"status": "online"
|
|
338
338
|
},
|
|
339
339
|
"DescribeFirstLinkSession": {
|
|
340
|
-
"document": "本接口（DescribeFirstLinkSession）用于查询接入段加速会话状态，包括会话状态，生效时长，加速套餐等信息。",
|
|
340
|
+
"document": "产品功能已下线，下线对应的api接口\n\n本接口（DescribeFirstLinkSession）用于查询接入段加速会话状态，包括会话状态，生效时长，加速套餐等信息。",
|
|
341
341
|
"input": "DescribeFirstLinkSessionRequest",
|
|
342
342
|
"name": "查询接入段加速会话信息",
|
|
343
343
|
"output": "DescribeFirstLinkSessionResponse",
|
|
344
|
-
"status": "
|
|
344
|
+
"status": "deprecated"
|
|
345
345
|
},
|
|
346
346
|
"DescribeGlobalDomainDns": {
|
|
347
347
|
"document": "查询域名解析列表",
|
|
@@ -923,7 +923,7 @@
|
|
|
923
923
|
{
|
|
924
924
|
"disabled": false,
|
|
925
925
|
"document": "源站名称",
|
|
926
|
-
"example": "
|
|
926
|
+
"example": "real_server_name",
|
|
927
927
|
"member": "string",
|
|
928
928
|
"name": "RealServerName",
|
|
929
929
|
"required": true,
|
|
@@ -950,7 +950,7 @@
|
|
|
950
950
|
"example": "无",
|
|
951
951
|
"member": "NewRealServer",
|
|
952
952
|
"name": "RealServerSet",
|
|
953
|
-
"
|
|
953
|
+
"output_required": true,
|
|
954
954
|
"type": "list",
|
|
955
955
|
"value_allowed_null": false
|
|
956
956
|
},
|
|
@@ -1966,7 +1966,7 @@
|
|
|
1966
1966
|
{
|
|
1967
1967
|
"disabled": false,
|
|
1968
1968
|
"document": "需要删除的响应头",
|
|
1969
|
-
"example": "[]",
|
|
1969
|
+
"example": "[\"Host\"]",
|
|
1970
1970
|
"member": "string",
|
|
1971
1971
|
"name": "ClearHeaders",
|
|
1972
1972
|
"required": false,
|
|
@@ -1993,7 +1993,7 @@
|
|
|
1993
1993
|
"example": "errorPage-1fewf",
|
|
1994
1994
|
"member": "string",
|
|
1995
1995
|
"name": "ErrorPageId",
|
|
1996
|
-
"
|
|
1996
|
+
"output_required": true,
|
|
1997
1997
|
"type": "string",
|
|
1998
1998
|
"value_allowed_null": false
|
|
1999
1999
|
},
|
|
@@ -2239,7 +2239,7 @@
|
|
|
2239
2239
|
{
|
|
2240
2240
|
"disabled": false,
|
|
2241
2241
|
"document": "别名",
|
|
2242
|
-
"example": "
|
|
2242
|
+
"example": "domain_name",
|
|
2243
2243
|
"member": "string",
|
|
2244
2244
|
"name": "Alias",
|
|
2245
2245
|
"required": false,
|
|
@@ -2266,6 +2266,7 @@
|
|
|
2266
2266
|
"example": "dm-pcp5xac5",
|
|
2267
2267
|
"member": "string",
|
|
2268
2268
|
"name": "DomainId",
|
|
2269
|
+
"output_required": true,
|
|
2269
2270
|
"type": "string",
|
|
2270
2271
|
"value_allowed_null": false
|
|
2271
2272
|
},
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"AddRealServers": [
|
|
4
4
|
{
|
|
5
5
|
"document": "",
|
|
6
|
-
"input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AddRealServers\n<公共请求参数>\n\n{\n \"ProjectId\": \"0\",\n \"RealServerName\": \"'
|
|
6
|
+
"input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: AddRealServers\n<公共请求参数>\n\n{\n \"ProjectId\": \"0\",\n \"RealServerName\": \"'server_name'\",\n \"RealServerIP\": [\n \"1.1.1.1\"\n ]\n}",
|
|
7
7
|
"output": "{\n \"Response\": {\n \"RealServerSet\": [\n {\n \"RealServerId\": \"id-5dr8gu4\",\n \"RealServerIP\": \"1.1.1.1\"\n }\n ],\n \"RequestId\": \"5c680029-66b2-4be8-9630-7bd316ce70dd\"\n }\n}",
|
|
8
8
|
"title": "添加源站"
|
|
9
9
|
},
|
|
@@ -103,7 +103,7 @@
|
|
|
103
103
|
"CreateDomainErrorPageInfo": [
|
|
104
104
|
{
|
|
105
105
|
"document": "",
|
|
106
|
-
"input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateDomainErrorPageInfo\n<公共请求参数>\n\n{\n \"Body\": \"
|
|
106
|
+
"input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateDomainErrorPageInfo\n<公共请求参数>\n\n{\n \"Body\": \"http-body\",\n \"Domain\": \"domain.com\",\n \"ListenerId\": \"0\",\n \"ErrorNos\": [\n \"502\",\n \"501\"\n ],\n \"NewErrorNo\": 400\n}",
|
|
107
107
|
"output": "{\n \"Response\": {\n \"RequestId\": \"c7bfcad5-3f20-472f-9afc-13a66faebad8\",\n \"ErrorPageId\": \"errorPage-1fewf\"\n }\n}",
|
|
108
108
|
"title": "CreateDomainErrorPageInfo"
|
|
109
109
|
}
|
|
@@ -117,12 +117,6 @@
|
|
|
117
117
|
}
|
|
118
118
|
],
|
|
119
119
|
"CreateGlobalDomain": [
|
|
120
|
-
{
|
|
121
|
-
"document": "创建域名",
|
|
122
|
-
"input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateGlobalDomain\n<公共请求参数>\n\n{\n \"ProjectId\": 0,\n \"DefaultValue\": \"1.1.1.1\",\n \"Alias\": \"test\"\n}",
|
|
123
|
-
"output": "{\n \"Response\": {\n \"DomainId\": \"dm-pcp5xac5\",\n \"RequestId\": \"0266e1f0-10a4-46ce-a118-29e360c90a1b\"\n }\n}",
|
|
124
|
-
"title": "创建域名"
|
|
125
|
-
},
|
|
126
120
|
{
|
|
127
121
|
"document": "创建域名示例",
|
|
128
122
|
"input": "POST / HTTP/1.1\nHost: gaap.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateGlobalDomain\n<公共请求参数>\n\n{\n \"ProjectId\": 0,\n \"DefaultValue\": \"127.0.0.1\",\n \"Alias\": \"www.baidu.com\"\n}",
|