tccli 3.0.1324.1__py2.py3-none-any.whl → 3.0.1325.1__py2.py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- tccli/__init__.py +1 -1
- tccli/services/autoscaling/v20180419/api.json +1 -1
- tccli/services/cfs/v20190719/api.json +45 -45
- tccli/services/cfs/v20190719/examples.json +1 -1
- tccli/services/cynosdb/v20190107/api.json +7 -7
- tccli/services/ess/v20201111/api.json +2 -2
- tccli/services/essbasic/v20210526/api.json +2 -2
- tccli/services/iotexplorer/v20190423/api.json +1 -1
- tccli/services/mqtt/mqtt_client.py +57 -4
- tccli/services/mqtt/v20240516/api.json +260 -124
- tccli/services/mqtt/v20240516/examples.json +9 -1
- {tccli-3.0.1324.1.dist-info → tccli-3.0.1325.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1324.1.dist-info → tccli-3.0.1325.1.dist-info}/RECORD +16 -16
- {tccli-3.0.1324.1.dist-info → tccli-3.0.1325.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1324.1.dist-info → tccli-3.0.1325.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1324.1.dist-info → tccli-3.0.1325.1.dist-info}/license_files/LICENSE +0 -0
tccli/__init__.py
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
__version__ = '3.0.
|
|
1
|
+
__version__ = '3.0.1325.1'
|
|
@@ -2446,7 +2446,7 @@
|
|
|
2446
2446
|
},
|
|
2447
2447
|
{
|
|
2448
2448
|
"disabled": false,
|
|
2449
|
-
"document": "数据盘大小，单位：GB。不同数据盘类型取值范围不同，具体限制详见：[CVM实例配置](https://cloud.tencent.com/document/product/213/2177)。默认值为0
|
|
2449
|
+
"document": "数据盘大小，单位：GB。不同数据盘类型取值范围不同，具体限制详见：[CVM实例配置](https://cloud.tencent.com/document/product/213/2177)。默认值为0，表示不购买数据盘。更多限制详见[产品文档](https://cloud.tencent.com/document/product/362/5145)。",
|
|
2450
2450
|
"example": "0",
|
|
2451
2451
|
"member": "uint64",
|
|
2452
2452
|
"name": "DiskSize",
|
|
@@ -211,7 +211,7 @@
|
|
|
211
211
|
"status": "online"
|
|
212
212
|
},
|
|
213
213
|
"ModifyFileSystemAutoScaleUpRule": {
|
|
214
|
-
"document": "
|
|
214
|
+
"document": "用来设置文件系统扩容策略，该接口只支持turbo文件系统",
|
|
215
215
|
"input": "ModifyFileSystemAutoScaleUpRuleRequest",
|
|
216
216
|
"name": "更新文件系统自动扩容策略",
|
|
217
217
|
"output": "ModifyFileSystemAutoScaleUpRuleResponse",
|
|
@@ -239,7 +239,7 @@
|
|
|
239
239
|
"status": "online"
|
|
240
240
|
},
|
|
241
241
|
"StopMigrationTask": {
|
|
242
|
-
"document": "
|
|
242
|
+
"document": "用于终止迁移任务，非运行中状态不支持终止。\n此接口需提交工单，开启白名单之后才能使用。",
|
|
243
243
|
"input": "StopMigrationTaskRequest",
|
|
244
244
|
"name": "终止迁移任务",
|
|
245
245
|
"output": "StopMigrationTaskResponse",
|
|
@@ -1234,7 +1234,7 @@
|
|
|
1234
1234
|
"members": [
|
|
1235
1235
|
{
|
|
1236
1236
|
"disabled": false,
|
|
1237
|
-
"document": "权限组 ID
|
|
1237
|
+
"document": "权限组 ID，可通过[DescribeCfsPGroups接口](https://cloud.tencent.com/document/api/582/38157)获取",
|
|
1238
1238
|
"example": "pgroup-12345",
|
|
1239
1239
|
"member": "string",
|
|
1240
1240
|
"name": "PGroupId",
|
|
@@ -1270,7 +1270,7 @@
|
|
|
1270
1270
|
},
|
|
1271
1271
|
{
|
|
1272
1272
|
"disabled": false,
|
|
1273
|
-
"document": "用户权限，值为 all_squash、no_all_squash、root_squash、no_root_squash
|
|
1273
|
+
"document": "用户权限，值为 all_squash、no_all_squash、root_squash、no_root_squash。默认值为root_squash\nall_squash：所有访问用户（含 root 用户）都会被映射为匿名用户或用户组。\nno_all_squash：所有访问用户（含 root 用户）均保持原有的 UID/GID 信息。\nroot_squash：将来访的 root 用户映射为匿名用户或用户组，非 root 用户保持原有的 UID/GID 信息。\nno_root_squash：与 no_all_squash 效果一致，所有访问用户（含 root 用户）均保持原有的 UID/GID 信息\n",
|
|
1274
1274
|
"example": "root_squash",
|
|
1275
1275
|
"member": "string",
|
|
1276
1276
|
"name": "UserPermission",
|
|
@@ -1357,7 +1357,7 @@
|
|
|
1357
1357
|
"members": [
|
|
1358
1358
|
{
|
|
1359
1359
|
"disabled": false,
|
|
1360
|
-
"document": "文件系统
|
|
1360
|
+
"document": "文件系统ID，通过查询文件系统列表获取；[DescribeCfsFileSystems](https://cloud.tencent.com/document/product/582/38170)",
|
|
1361
1361
|
"example": "cfs-gagaggag",
|
|
1362
1362
|
"member": "string",
|
|
1363
1363
|
"name": "FileSystemId",
|
|
@@ -1366,7 +1366,7 @@
|
|
|
1366
1366
|
},
|
|
1367
1367
|
{
|
|
1368
1368
|
"disabled": false,
|
|
1369
|
-
"document": "
|
|
1369
|
+
"document": "快照名称，支持不超过64字符长度，支持中文、数字、_、-",
|
|
1370
1370
|
"example": "CFS定期快照",
|
|
1371
1371
|
"member": "string",
|
|
1372
1372
|
"name": "SnapshotName",
|
|
@@ -1584,7 +1584,7 @@
|
|
|
1584
1584
|
"members": [
|
|
1585
1585
|
{
|
|
1586
1586
|
"disabled": false,
|
|
1587
|
-
"document": "快照策略ID
|
|
1587
|
+
"document": "快照策略ID，查询快照策略接口获取,[DescribeAutoSnapshotPolicies](https://cloud.tencent.com/document/api/582/80208)",
|
|
1588
1588
|
"example": "asp-123abc",
|
|
1589
1589
|
"member": "string",
|
|
1590
1590
|
"name": "AutoSnapshotPolicyId",
|
|
@@ -1621,7 +1621,7 @@
|
|
|
1621
1621
|
"members": [
|
|
1622
1622
|
{
|
|
1623
1623
|
"disabled": false,
|
|
1624
|
-
"document": "文件系统 ID
|
|
1624
|
+
"document": "文件系统 ID，通过[查询文件系统接口](https://cloud.tencent.com/document/api/582/38170)获取。说明，进行删除文件系统操作前需要先调用 DeleteMountTarget 接口删除该文件系统的挂载点，否则会删除失败。",
|
|
1625
1625
|
"example": "cfs-12345",
|
|
1626
1626
|
"member": "string",
|
|
1627
1627
|
"name": "FileSystemId",
|
|
@@ -1648,7 +1648,7 @@
|
|
|
1648
1648
|
"members": [
|
|
1649
1649
|
{
|
|
1650
1650
|
"disabled": false,
|
|
1651
|
-
"document": "权限组 ID
|
|
1651
|
+
"document": "权限组 ID，可通过[DescribeCfsPGroups接口](https://cloud.tencent.com/document/api/582/38157)获取",
|
|
1652
1652
|
"example": "pgroup-12345",
|
|
1653
1653
|
"member": "string",
|
|
1654
1654
|
"name": "PGroupId",
|
|
@@ -1695,7 +1695,7 @@
|
|
|
1695
1695
|
"members": [
|
|
1696
1696
|
{
|
|
1697
1697
|
"disabled": false,
|
|
1698
|
-
"document": "权限组 ID
|
|
1698
|
+
"document": "权限组 ID，可通过[DescribeCfsPGroups接口](https://cloud.tencent.com/document/api/582/38157)获取",
|
|
1699
1699
|
"example": "pgroup-12345",
|
|
1700
1700
|
"member": "string",
|
|
1701
1701
|
"name": "PGroupId",
|
|
@@ -1704,7 +1704,7 @@
|
|
|
1704
1704
|
},
|
|
1705
1705
|
{
|
|
1706
1706
|
"disabled": false,
|
|
1707
|
-
"document": "规则 ID
|
|
1707
|
+
"document": "规则 ID，可通过[DescribeCfsRules](https://cloud.tencent.com/document/api/582/38156)接口获取",
|
|
1708
1708
|
"example": "rule-12345",
|
|
1709
1709
|
"member": "string",
|
|
1710
1710
|
"name": "RuleId",
|
|
@@ -1751,8 +1751,8 @@
|
|
|
1751
1751
|
"members": [
|
|
1752
1752
|
{
|
|
1753
1753
|
"disabled": false,
|
|
1754
|
-
"document": "
|
|
1755
|
-
"example": "snapcfs-
|
|
1754
|
+
"document": "快照ID，可以通过[DescribeCfsSnapshots](https://cloud.tencent.com/document/api/582/80206) 查询获取",
|
|
1755
|
+
"example": "snapcfs-1245abcd",
|
|
1756
1756
|
"member": "string",
|
|
1757
1757
|
"name": "SnapshotId",
|
|
1758
1758
|
"required": false,
|
|
@@ -1760,7 +1760,7 @@
|
|
|
1760
1760
|
},
|
|
1761
1761
|
{
|
|
1762
1762
|
"disabled": false,
|
|
1763
|
-
"document": "需要删除的文件系统快照ID 列表，快照ID，跟ID
|
|
1763
|
+
"document": "需要删除的文件系统快照ID 列表，快照ID，跟ID列表至少填一项\n快照ID，可以通过[DescribeCfsSnapshots](https://cloud.tencent.com/document/api/582/80206) 查询获取",
|
|
1764
1764
|
"example": "[\"snapcfs-xx\",\"snapcfs-xx1\"]",
|
|
1765
1765
|
"member": "string",
|
|
1766
1766
|
"name": "SnapshotIds",
|
|
@@ -1860,8 +1860,8 @@
|
|
|
1860
1860
|
"members": [
|
|
1861
1861
|
{
|
|
1862
1862
|
"disabled": false,
|
|
1863
|
-
"document": "文件系统
|
|
1864
|
-
"example": "cfs-
|
|
1863
|
+
"document": "文件系统ID，通过查询文件系统列表获取；[DescribeCfsFileSystems](https://cloud.tencent.com/document/product/582/38170)",
|
|
1864
|
+
"example": "cfs-12345efg",
|
|
1865
1865
|
"member": "string",
|
|
1866
1866
|
"name": "FileSystemId",
|
|
1867
1867
|
"required": true,
|
|
@@ -2098,7 +2098,7 @@
|
|
|
2098
2098
|
"members": [
|
|
2099
2099
|
{
|
|
2100
2100
|
"disabled": false,
|
|
2101
|
-
"document": "文件系统 ID
|
|
2101
|
+
"document": "文件系统 ID，通过[查询文件系统接口](https://cloud.tencent.com/document/api/582/38170)获取",
|
|
2102
2102
|
"example": "cfs-12345",
|
|
2103
2103
|
"member": "string",
|
|
2104
2104
|
"name": "FileSystemId",
|
|
@@ -2282,7 +2282,7 @@
|
|
|
2282
2282
|
"members": [
|
|
2283
2283
|
{
|
|
2284
2284
|
"disabled": false,
|
|
2285
|
-
"document": "权限组 ID
|
|
2285
|
+
"document": "权限组 ID，可通过[DescribeCfsPGroups接口](https://cloud.tencent.com/document/api/582/38157)获取",
|
|
2286
2286
|
"example": "pgroup-12345",
|
|
2287
2287
|
"member": "string",
|
|
2288
2288
|
"name": "PGroupId",
|
|
@@ -2418,7 +2418,7 @@
|
|
|
2418
2418
|
},
|
|
2419
2419
|
{
|
|
2420
2420
|
"disabled": false,
|
|
2421
|
-
"document": "按创建时间排序取值
|
|
2421
|
+
"document": "按创建时间排序取值",
|
|
2422
2422
|
"example": "CreationTime",
|
|
2423
2423
|
"member": "string",
|
|
2424
2424
|
"name": "OrderField",
|
|
@@ -2502,7 +2502,7 @@
|
|
|
2502
2502
|
},
|
|
2503
2503
|
{
|
|
2504
2504
|
"disabled": false,
|
|
2505
|
-
"document": "<br><li> taskId
|
|
2505
|
+
"document": "<br><li> taskId按照【迁移任务id】进行过滤。类型：String必选：否<br></li><br><li> taskName按照【迁移任务名字】进行模糊搜索过滤。类型：String必选：否每次请求的Filters的上限为10，Filter.Values的上限为100。</li>",
|
|
2506
2506
|
"example": "无",
|
|
2507
2507
|
"member": "Filter",
|
|
2508
2508
|
"name": "Filters",
|
|
@@ -2517,7 +2517,7 @@
|
|
|
2517
2517
|
"members": [
|
|
2518
2518
|
{
|
|
2519
2519
|
"disabled": false,
|
|
2520
|
-
"document": "
|
|
2520
|
+
"document": "迁移任务的总数量",
|
|
2521
2521
|
"example": "0",
|
|
2522
2522
|
"member": "int64",
|
|
2523
2523
|
"name": "TotalCount",
|
|
@@ -2549,7 +2549,7 @@
|
|
|
2549
2549
|
"members": [
|
|
2550
2550
|
{
|
|
2551
2551
|
"disabled": false,
|
|
2552
|
-
"document": "文件系统 ID
|
|
2552
|
+
"document": "文件系统 ID，[查询文件系统列表](https://cloud.tencent.com/document/api/582/38170)可以获得id",
|
|
2553
2553
|
"example": "cfs-12345",
|
|
2554
2554
|
"member": "string",
|
|
2555
2555
|
"name": "FileSystemId",
|
|
@@ -2596,8 +2596,8 @@
|
|
|
2596
2596
|
"members": [
|
|
2597
2597
|
{
|
|
2598
2598
|
"disabled": false,
|
|
2599
|
-
"document": "
|
|
2600
|
-
"example": "snapcfs-
|
|
2599
|
+
"document": "快照ID，可以通过[DescribeCfsSnapshots](https://cloud.tencent.com/document/api/582/80206) 查询获取",
|
|
2600
|
+
"example": "snapcfs-123abcdd",
|
|
2601
2601
|
"member": "string",
|
|
2602
2602
|
"name": "SnapshotId",
|
|
2603
2603
|
"required": true,
|
|
@@ -2605,7 +2605,7 @@
|
|
|
2605
2605
|
},
|
|
2606
2606
|
{
|
|
2607
2607
|
"disabled": false,
|
|
2608
|
-
"document": "
|
|
2608
|
+
"document": "起始时间，格式“YYYY-MM-DD hh:mm:ss”",
|
|
2609
2609
|
"example": "2021-08-11 11:51:33",
|
|
2610
2610
|
"member": "string",
|
|
2611
2611
|
"name": "StartTime",
|
|
@@ -2614,7 +2614,7 @@
|
|
|
2614
2614
|
},
|
|
2615
2615
|
{
|
|
2616
2616
|
"disabled": false,
|
|
2617
|
-
"document": "
|
|
2617
|
+
"document": "结束时间，格式“YYYY-MM-DD hh:mm:ss”",
|
|
2618
2618
|
"example": "2021-08-11 11:51:33",
|
|
2619
2619
|
"member": "string",
|
|
2620
2620
|
"name": "EndTime",
|
|
@@ -2661,7 +2661,7 @@
|
|
|
2661
2661
|
"members": [
|
|
2662
2662
|
{
|
|
2663
2663
|
"disabled": false,
|
|
2664
|
-
"document": "文件系统 ID
|
|
2664
|
+
"document": "文件系统 ID,通过[查询文件系统列表](https://cloud.tencent.com/document/api/582/38170)获取",
|
|
2665
2665
|
"example": "cfs-abc12345",
|
|
2666
2666
|
"member": "string",
|
|
2667
2667
|
"name": "FileSystemId",
|
|
@@ -2841,7 +2841,7 @@
|
|
|
2841
2841
|
},
|
|
2842
2842
|
{
|
|
2843
2843
|
"disabled": false,
|
|
2844
|
-
"document": "可用区名称，例如ap-beijing-1
|
|
2844
|
+
"document": "可用区名称，例如ap-beijing-1，参考[简介](https://cloud.tencent.com/document/api/582/38144)文档中的地域与可用区列表",
|
|
2845
2845
|
"example": "ap-guangzhou-1",
|
|
2846
2846
|
"member": "string",
|
|
2847
2847
|
"name": "Zone",
|
|
@@ -3433,7 +3433,7 @@
|
|
|
3433
3433
|
"members": [
|
|
3434
3434
|
{
|
|
3435
3435
|
"disabled": false,
|
|
3436
|
-
"document": "文件系统
|
|
3436
|
+
"document": "文件系统ID，通过查询文件系统列表获取；[DescribeCfsFileSystems](https://cloud.tencent.com/document/product/582/38170)",
|
|
3437
3437
|
"example": "cfs-4abc12343",
|
|
3438
3438
|
"member": "string",
|
|
3439
3439
|
"name": "FileSystemId",
|
|
@@ -3847,7 +3847,7 @@
|
|
|
3847
3847
|
"members": [
|
|
3848
3848
|
{
|
|
3849
3849
|
"disabled": false,
|
|
3850
|
-
"document": "文件系统 ID
|
|
3850
|
+
"document": "文件系统 ID,通过[查询文件系统列表](https://cloud.tencent.com/document/api/582/38170)获取",
|
|
3851
3851
|
"example": "cfs-abc12345",
|
|
3852
3852
|
"member": "string",
|
|
3853
3853
|
"name": "FileSystemId",
|
|
@@ -4307,7 +4307,7 @@
|
|
|
4307
4307
|
"members": [
|
|
4308
4308
|
{
|
|
4309
4309
|
"disabled": false,
|
|
4310
|
-
"document": "需要解绑的文件系统ID列表，用\",\" 分割，文件系统
|
|
4310
|
+
"document": "需要解绑的文件系统ID列表，用\",\" 分割，文件系统ID，通过查询文件系统列表获取；[DescribeCfsFileSystems](https://cloud.tencent.com/document/product/582/38170)",
|
|
4311
4311
|
"example": "cfs-abc,cfs-dbc",
|
|
4312
4312
|
"member": "string",
|
|
4313
4313
|
"name": "FileSystemIds",
|
|
@@ -4316,7 +4316,7 @@
|
|
|
4316
4316
|
},
|
|
4317
4317
|
{
|
|
4318
4318
|
"disabled": false,
|
|
4319
|
-
"document": "
|
|
4319
|
+
"document": "解绑的快照策略ID，可以通过[DescribeAutoSnapshotPolicies](https://cloud.tencent.com/document/api/582/80208) 查询获取",
|
|
4320
4320
|
"example": "asp-gagagacg",
|
|
4321
4321
|
"member": "string",
|
|
4322
4322
|
"name": "AutoSnapshotPolicyId",
|
|
@@ -4353,8 +4353,8 @@
|
|
|
4353
4353
|
"members": [
|
|
4354
4354
|
{
|
|
4355
4355
|
"disabled": false,
|
|
4356
|
-
"document": "
|
|
4357
|
-
"example": "asp-
|
|
4356
|
+
"document": "解绑的快照策略ID，可以通过[DescribeAutoSnapshotPolicies](https://cloud.tencent.com/document/api/582/80208) 查询获取",
|
|
4357
|
+
"example": "asp-1234abcd",
|
|
4358
4358
|
"member": "string",
|
|
4359
4359
|
"name": "AutoSnapshotPolicyId",
|
|
4360
4360
|
"required": true,
|
|
@@ -4453,8 +4453,8 @@
|
|
|
4453
4453
|
"members": [
|
|
4454
4454
|
{
|
|
4455
4455
|
"disabled": false,
|
|
4456
|
-
"document": "文件系统 ID",
|
|
4457
|
-
"example": "cfs-
|
|
4456
|
+
"document": "文件系统 ID,通过[查询文件系统接口](https://cloud.tencent.com/document/api/582/38170)获取",
|
|
4457
|
+
"example": "cfs-abc12345",
|
|
4458
4458
|
"member": "string",
|
|
4459
4459
|
"name": "FileSystemId",
|
|
4460
4460
|
"required": true,
|
|
@@ -4462,7 +4462,7 @@
|
|
|
4462
4462
|
},
|
|
4463
4463
|
{
|
|
4464
4464
|
"disabled": false,
|
|
4465
|
-
"document": "
|
|
4465
|
+
"document": "用户自定义文件系统名称，64字节内的中文字母数字或者 _,-,与CreationToken 至少填一个",
|
|
4466
4466
|
"example": "fs_name",
|
|
4467
4467
|
"member": "string",
|
|
4468
4468
|
"name": "FsName",
|
|
@@ -4519,7 +4519,7 @@
|
|
|
4519
4519
|
"members": [
|
|
4520
4520
|
{
|
|
4521
4521
|
"disabled": false,
|
|
4522
|
-
"document": "权限组 ID
|
|
4522
|
+
"document": "权限组 ID，可通过[DescribeCfsPGroups接口](https://cloud.tencent.com/document/api/582/38157)获取",
|
|
4523
4523
|
"example": "pgroup-12345",
|
|
4524
4524
|
"member": "string",
|
|
4525
4525
|
"name": "PGroupId",
|
|
@@ -4528,7 +4528,7 @@
|
|
|
4528
4528
|
},
|
|
4529
4529
|
{
|
|
4530
4530
|
"disabled": false,
|
|
4531
|
-
"document": "文件系统 ID
|
|
4531
|
+
"document": "文件系统 ID，通过[查询文件系统接口](https://cloud.tencent.com/document/api/582/38170)获取",
|
|
4532
4532
|
"example": "cfs-12345",
|
|
4533
4533
|
"member": "string",
|
|
4534
4534
|
"name": "FileSystemId",
|
|
@@ -4611,7 +4611,7 @@
|
|
|
4611
4611
|
"members": [
|
|
4612
4612
|
{
|
|
4613
4613
|
"disabled": false,
|
|
4614
|
-
"document": "权限组 ID
|
|
4614
|
+
"document": "权限组 ID，可通过[DescribeCfsPGroups接口](https://cloud.tencent.com/document/api/582/38157)获取",
|
|
4615
4615
|
"example": "pgroup-12345",
|
|
4616
4616
|
"member": "string",
|
|
4617
4617
|
"name": "PGroupId",
|
|
@@ -4686,7 +4686,7 @@
|
|
|
4686
4686
|
"members": [
|
|
4687
4687
|
{
|
|
4688
4688
|
"disabled": false,
|
|
4689
|
-
"document": "权限组 ID
|
|
4689
|
+
"document": "权限组 ID，可通过[DescribeCfsPGroups接口](https://cloud.tencent.com/document/api/582/38157)获取",
|
|
4690
4690
|
"example": "pgroup-12345",
|
|
4691
4691
|
"member": "string",
|
|
4692
4692
|
"name": "PGroupId",
|
|
@@ -4695,7 +4695,7 @@
|
|
|
4695
4695
|
},
|
|
4696
4696
|
{
|
|
4697
4697
|
"disabled": false,
|
|
4698
|
-
"document": "规则 ID
|
|
4698
|
+
"document": "规则 ID，可通过[DescribeCfsRules](https://cloud.tencent.com/document/api/582/38156)接口获取",
|
|
4699
4699
|
"example": "rule-12345",
|
|
4700
4700
|
"member": "string",
|
|
4701
4701
|
"name": "RuleId",
|
|
@@ -4818,7 +4818,7 @@
|
|
|
4818
4818
|
"members": [
|
|
4819
4819
|
{
|
|
4820
4820
|
"disabled": false,
|
|
4821
|
-
"document": "
|
|
4821
|
+
"document": "快照ID，可以通过[DescribeCfsSnapshots](https://cloud.tencent.com/document/api/582/80206) 查询获取",
|
|
4822
4822
|
"example": "snapcfs-4agklgllg",
|
|
4823
4823
|
"member": "string",
|
|
4824
4824
|
"name": "SnapshotId",
|
|
@@ -4827,7 +4827,7 @@
|
|
|
4827
4827
|
},
|
|
4828
4828
|
{
|
|
4829
4829
|
"disabled": false,
|
|
4830
|
-
"document": "文件系统快照名称，与AliveDays
|
|
4830
|
+
"document": "文件系统快照名称，与AliveDays 必须填一个，快照名称，支持不超过64字符长度，支持中文、数字、_、-",
|
|
4831
4831
|
"example": "snapshot123",
|
|
4832
4832
|
"member": "string",
|
|
4833
4833
|
"name": "SnapshotName",
|
|
@@ -4873,7 +4873,7 @@
|
|
|
4873
4873
|
"members": [
|
|
4874
4874
|
{
|
|
4875
4875
|
"disabled": false,
|
|
4876
|
-
"document": "文件系统 ID
|
|
4876
|
+
"document": "文件系统 ID,可通过[DescribeCfsFileSystems](https://cloud.tencent.com/document/api/582/38170)接口获取",
|
|
4877
4877
|
"example": "cfs-abcd1234",
|
|
4878
4878
|
"member": "string",
|
|
4879
4879
|
"name": "FileSystemId",
|
|
@@ -212,7 +212,7 @@
|
|
|
212
212
|
{
|
|
213
213
|
"document": "用于获取迁移任务列表",
|
|
214
214
|
"input": "POST / HTTP/1.1\nHost: cfs.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeMigrationTasks\n<公共请求参数>\n\n{\n \"Limit\": 20,\n \"Offset\": 0\n}",
|
|
215
|
-
"output": "{\n \"Response\": {\n \"MigrationTasks\": [\n {\n \"TaskName\": \"taskName\",\n \"TaskId\": \"cfsmigrate-29d43e98\",\n \"MigrationType\": 0,\n \"MigrationMode\": 0,\n \"BucketName\": \"bucket-1\",\n \"BucketRegion\": \"oss-cn-beijing\",\n \"BucketAddress\": \"https://test-1.oss-cn-beijing.aliyuncs.com\",\n \"BucketPath\": \"\",\n \"ListAddress\": \"\",\n \"FsName\": \"t1\",\n \"FileSystemId\": \"cfs-qz5c44o1\",\n \"FsPath\": \"/ahh\",\n \"CoverType\": 0,\n \"Status\": 6,\n \"FileTotalCount\": 0,\n \"FileMigratedCount\": 0,\n \"FileFailedCount\": 0,\n \"FileTotalSize\": 0,\n \"FileMigratedSize\": 0,\n \"FileFailedSize\": 0,\n \"FileTotalList\":
|
|
215
|
+
"output": "{\n \"Response\": {\n \"MigrationTasks\": [\n {\n \"TaskName\": \"taskName\",\n \"TaskId\": \"cfsmigrate-29d43e98\",\n \"MigrationType\": 0,\n \"MigrationMode\": 0,\n \"BucketName\": \"bucket-1\",\n \"BucketRegion\": \"oss-cn-beijing\",\n \"BucketAddress\": \"https://test-1.oss-cn-beijing.aliyuncs.com\",\n \"BucketPath\": \"\",\n \"ListAddress\": \"\",\n \"FsName\": \"t1\",\n \"FileSystemId\": \"cfs-qz5c44o1\",\n \"FsPath\": \"/ahh\",\n \"CoverType\": 0,\n \"Status\": 6,\n \"FileTotalCount\": 0,\n \"FileMigratedCount\": 0,\n \"FileFailedCount\": 0,\n \"FileTotalSize\": 0,\n \"FileMigratedSize\": 0,\n \"FileFailedSize\": 0,\n \"FileTotalList\": \"\",\n \"FileCompletedList\": \"\",\n \"FileFailedList\": \"\",\n \"CreateTime\": 1662023240000,\n \"EndTime\": 1662023548000,\n \"Direction\": 0\n }\n ],\n \"TotalCount\": 1,\n \"RequestId\": \"c0f7c5d9-c8c4-401a-a6da-2106f3c6db76\"\n }\n}",
|
|
216
216
|
"title": "获取迁移任务列表"
|
|
217
217
|
}
|
|
218
218
|
],
|
|
@@ -12920,7 +12920,7 @@
|
|
|
12920
12920
|
},
|
|
12921
12921
|
{
|
|
12922
12922
|
"disabled": false,
|
|
12923
|
-
"document": "
|
|
12923
|
+
"document": "过滤条件，支持的搜索字段：\"ClusterId\"、\"ClusterName\"、\"InstanceId\"、\"InstanceName\"、\"Status\"、\"TaskId\"、\"TaskType\"",
|
|
12924
12924
|
"example": "无",
|
|
12925
12925
|
"member": "QueryFilter",
|
|
12926
12926
|
"name": "Filters",
|
|
@@ -19789,19 +19789,19 @@
|
|
|
19789
19789
|
"members": [
|
|
19790
19790
|
{
|
|
19791
19791
|
"disabled": false,
|
|
19792
|
-
"document": "
|
|
19793
|
-
"example": "[\"
|
|
19792
|
+
"document": "搜索字符串",
|
|
19793
|
+
"example": "[\"1723\"]",
|
|
19794
19794
|
"member": "string",
|
|
19795
|
-
"name": "
|
|
19795
|
+
"name": "Values",
|
|
19796
19796
|
"required": true,
|
|
19797
19797
|
"type": "list"
|
|
19798
19798
|
},
|
|
19799
19799
|
{
|
|
19800
19800
|
"disabled": false,
|
|
19801
|
-
"document": "
|
|
19802
|
-
"example": "[\"
|
|
19801
|
+
"document": "搜索字段，目前支持：\"InstanceId\", \"ProjectId\", \"InstanceName\", \"Vip\"",
|
|
19802
|
+
"example": "[\"projectId\"]",
|
|
19803
19803
|
"member": "string",
|
|
19804
|
-
"name": "
|
|
19804
|
+
"name": "Names",
|
|
19805
19805
|
"required": true,
|
|
19806
19806
|
"type": "list"
|
|
19807
19807
|
},
|
|
@@ -2009,7 +2009,7 @@
|
|
|
2009
2009
|
"members": [
|
|
2010
2010
|
{
|
|
2011
2011
|
"disabled": false,
|
|
2012
|
-
"document": "**如果是Component填写控件类型，则可选的字段为**：\n\n<ul><li> <b>TEXT</b> : 普通文本控件，输入文本字符串；</li>\n<li> <b>MULTI_LINE_TEXT</b> : 多行文本控件，输入文本字符串；</li>\n<li> <b>CHECK_BOX</b> : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；</li>\n<li> <b>FILL_IMAGE</b> : 图片控件，ComponentValue 填写图片的资源 ID；</li>\n<li> <b>DYNAMIC_TABLE</b> : 动态表格控件；</li>\n<li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；</li>\n<li> <b>SELECTOR</b> : 选择器控件，ComponentValue填写选择的字符串内容；</li>\n<li> <b>DATE</b> : 日期控件；默认是格式化为xxxx年xx月xx日字符串；</li>\n<li> <b>WATERMARK</b> : 水印控件；只能分配给发起方，必须设置ComponentExtra；</li>\n<li> <b>DISTRICT</b> : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；</li></ul>\n\n**如果是SignComponent签署控件类型，\n需要根据签署人的类型可选的字段为**\n* 企业方\n<ul><li> <b>SIGN_SEAL</b> : 签署印章控件；</li>\n<li> <b>SIGN_DATE</b> : 签署日期控件；</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li>\n<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li>\n<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li>\n<li> <b>SIGN_SELECTOR</b> : 选择器，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li>\n<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>\n\n* 个人方\n<ul><li> <b>SIGN_DATE</b> : 签署日期控件；</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>\n<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li>\n<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li>\n<li> <b>SIGN_SELECTOR</b> : 选择器，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li></ul>\n \n注：` 表单域的控件不能作为印章和签名控件`",
|
|
2012
|
+
"document": "**如果是Component填写控件类型，则可选的字段为**：\n\n<ul><li> <b>TEXT</b> : 普通文本控件，输入文本字符串；</li>\n<li> <b>MULTI_LINE_TEXT</b> : 多行文本控件，输入文本字符串；</li>\n<li> <b>CHECK_BOX</b> : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；</li>\n<li> <b>FILL_IMAGE</b> : 图片控件，ComponentValue 填写图片的资源 ID；</li>\n<li> <b>DYNAMIC_TABLE</b> : 动态表格控件；</li>\n<li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；</li>\n<li> <b>SELECTOR</b> : 选择器控件，ComponentValue填写选择的字符串内容；</li>\n<li> <b>DATE</b> : 日期控件；默认是格式化为xxxx年xx月xx日字符串；</li>\n<li> <b>WATERMARK</b> : 水印控件；只能分配给发起方，必须设置ComponentExtra；</li>\n<li> <b>DISTRICT</b> : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；</li></ul>\n\n**如果是SignComponent签署控件类型，\n需要根据签署人的类型可选的字段为**\n* 企业方\n<ul><li> <b>SIGN_SEAL</b> : 签署印章控件；</li>\n<li> <b>SIGN_DATE</b> : 签署日期控件；</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>\n<li> <b>SIGN_PAGING_SIGNATURE</b> : 用户签名骑缝章控件；；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li>\n<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li>\n<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li>\n<li> <b>SIGN_SELECTOR</b> : 选择器，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li>\n<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>\n\n* 个人方\n<ul><li> <b>SIGN_DATE</b> : 签署日期控件；</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>\n<li> <b>SIGN_PAGING_SIGNATURE</b> : 用户签名骑缝章控件；</li>\n<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li>\n<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li>\n<li> <b>SIGN_SELECTOR</b> : 选择器，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li></ul>\n \n注：` 表单域的控件不能作为印章和签名控件`",
|
|
2013
2013
|
"example": "SIGN_SEAL",
|
|
2014
2014
|
"member": "string",
|
|
2015
2015
|
"name": "ComponentType",
|
|
@@ -2141,7 +2141,7 @@
|
|
|
2141
2141
|
},
|
|
2142
2142
|
{
|
|
2143
2143
|
"disabled": false,
|
|
2144
|
-
"document": "\n**在所有的定位方式下**，控件的扩展参数，为<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>： 范围6 :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>： 范围6 :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>\n<li> <b>OTHER</b> : 其他</li>\n</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、SIGN_SIGNATURE类型时</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",
|
|
2144
|
+
"document": "\n**在所有的定位方式下**，控件的扩展参数，为<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>： 范围6 :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>： 范围6 :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、SIGN_PAGING_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>\n<li> <b>OTHER</b> : 其他</li>\n</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、SIGN_SIGNATURE类型时</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",
|
|
2145
2145
|
"example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}",
|
|
2146
2146
|
"member": "string",
|
|
2147
2147
|
"name": "ComponentExtra",
|
|
@@ -6151,7 +6151,7 @@
|
|
|
6151
6151
|
},
|
|
6152
6152
|
{
|
|
6153
6153
|
"disabled": false,
|
|
6154
|
-
"document": "**如果是Component填写控件类型，则可选的字段为**：\n\n<ul><li> <b>TEXT</b> : 普通文本控件，输入文本字符串；</li>\n<li> <b>MULTI_LINE_TEXT</b> : 多行文本控件，输入文本字符串；</li>\n<li> <b>CHECK_BOX</b> : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；</li>\n<li> <b>FILL_IMAGE</b> : 图片控件，ComponentValue 填写图片的资源 ID；</li>\n<li> <b>DYNAMIC_TABLE</b> : 动态表格控件；</li>\n<li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；</li>\n<li> <b>SELECTOR</b> : 选择器控件，ComponentValue填写选择的字符串内容；</li>\n<li> <b>DATE</b> : 日期控件；默认是格式化为xxxx年xx月xx日字符串；</li>\n<li> <b>DISTRICT</b> : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；</li></ul>\n\n**如果是SignComponent签署控件类型，\n需要根据签署人的类型可选的字段为**\n* 企业方\n<ul><li> <b>SIGN_SEAL</b> : 签署印章控件；</li>\n<li> <b>SIGN_DATE</b> : 签署日期控件；</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li>\n<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li>\n<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li>\n<li> <b>SIGN_SELECTOR</b> : 选择器，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li>\n<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>\n\n\n* 个人方\n<ul><li> <b>SIGN_DATE</b> : 签署日期控件；</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li>\n<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li>\n<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li>\n<li> <b>SIGN_SELECTOR</b> : 选择器，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li>\n</ul>\n \n注：` 表单域的控件不能作为印章和签名控件`",
|
|
6154
|
+
"document": "**如果是Component填写控件类型，则可选的字段为**：\n\n<ul><li> <b>TEXT</b> : 普通文本控件，输入文本字符串；</li>\n<li> <b>MULTI_LINE_TEXT</b> : 多行文本控件，输入文本字符串；</li>\n<li> <b>CHECK_BOX</b> : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；</li>\n<li> <b>FILL_IMAGE</b> : 图片控件，ComponentValue 填写图片的资源 ID；</li>\n<li> <b>DYNAMIC_TABLE</b> : 动态表格控件；</li>\n<li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；</li>\n<li> <b>SELECTOR</b> : 选择器控件，ComponentValue填写选择的字符串内容；</li>\n<li> <b>DATE</b> : 日期控件；默认是格式化为xxxx年xx月xx日字符串；</li>\n<li> <b>DISTRICT</b> : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；</li></ul>\n\n**如果是SignComponent签署控件类型，\n需要根据签署人的类型可选的字段为**\n* 企业方\n<ul><li> <b>SIGN_SEAL</b> : 签署印章控件；</li>\n<li> <b>SIGN_DATE</b> : 签署日期控件；</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>\n<li> <b>SIGN_PAGING_SIGNATURE</b> : 用户签名骑缝章控件；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>\n<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li>\n<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li>\n<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li>\n<li> <b>SIGN_SELECTOR</b> : 选择器，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li>\n<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>\n\n\n* 个人方\n<ul><li> <b>SIGN_DATE</b> : 签署日期控件；</li>\n<li> <b>SIGN_SIGNATURE</b> : 用户签名控件；</li>\n<li> <b>SIGN_PAGING_SIGNATURE</b> : 用户签名骑缝章控件；</li>\n<li> <b>SIGN_OPINION</b> : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；</li>\n<li> <b>SIGN_VIRTUAL_COMBINATION</b> : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容</li>\n<li> <b>SIGN_MULTI_LINE_TEXT</b> : 多行文本，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作批注附言</li>\n<li> <b>SIGN_SELECTOR</b> : 选择器，<font color=\"red\">仅可用在签批控件内部作为组合控件，单独无法使用</font>，常用作审批意见的选择</li>\n</ul>\n \n注：` 表单域的控件不能作为印章和签名控件`",
|
|
6155
6155
|
"example": "SIGN_SEAL",
|
|
6156
6156
|
"member": "string",
|
|
6157
6157
|
"name": "ComponentType",
|
|
@@ -6272,7 +6272,7 @@
|
|
|
6272
6272
|
},
|
|
6273
6273
|
{
|
|
6274
6274
|
"disabled": false,
|
|
6275
|
-
"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>： 范围6 :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>： 范围6 :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>\n<li> <b>OTHER</b> : 其他</li>\n</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、SIGN_SIGNATURE类型时</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",
|
|
6275
|
+
"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>： 范围6 :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>： 范围6 :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、SIGN_PAGING_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>\n<li> <b>OTHER</b> : 其他</li>\n</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、SIGN_SIGNATURE类型时</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",
|
|
6276
6276
|
"example": "ComponentExtra",
|
|
6277
6277
|
"member": "string",
|
|
6278
6278
|
"name": "ComponentExtra",
|