tccli 3.0.1263.1__py2.py3-none-any.whl → 3.0.1265.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.
Files changed (50) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/aiart/v20221229/api.json +2 -2
  3. tccli/services/batch/v20170312/api.json +2 -2
  4. tccli/services/bh/v20230418/api.json +490 -5
  5. tccli/services/bh/v20230418/examples.json +2 -2
  6. tccli/services/cbs/v20170312/api.json +12 -2
  7. tccli/services/cbs/v20170312/examples.json +2 -2
  8. tccli/services/cdb/v20170320/api.json +2 -2
  9. tccli/services/cdb/v20170320/examples.json +5 -5
  10. tccli/services/cfw/cfw_client.py +0 -53
  11. tccli/services/cfw/v20190904/api.json +0 -163
  12. tccli/services/cfw/v20190904/examples.json +0 -8
  13. tccli/services/chdfs/v20201112/api.json +7 -7
  14. tccli/services/ckafka/v20190819/api.json +11 -2
  15. tccli/services/cls/v20201016/api.json +10 -1
  16. tccli/services/cvm/v20170312/api.json +2 -2
  17. tccli/services/cwp/cwp_client.py +69 -175
  18. tccli/services/cwp/v20180228/api.json +0 -374
  19. tccli/services/cwp/v20180228/examples.json +0 -16
  20. tccli/services/dsgc/v20190723/api.json +12 -3
  21. tccli/services/ess/v20201111/api.json +1 -1
  22. tccli/services/essbasic/v20210526/api.json +1 -1
  23. tccli/services/facefusion/v20220927/api.json +2 -2
  24. tccli/services/lighthouse/v20200324/api.json +84 -7
  25. tccli/services/lighthouse/v20200324/examples.json +2 -2
  26. tccli/services/live/v20180801/api.json +1 -1
  27. tccli/services/lkeap/v20240522/api.json +2 -2
  28. tccli/services/mna/v20210119/api.json +41 -41
  29. tccli/services/mongodb/v20190725/api.json +15 -15
  30. tccli/services/mongodb/v20190725/examples.json +5 -5
  31. tccli/services/monitor/v20180724/api.json +22 -20
  32. tccli/services/monitor/v20180724/examples.json +3 -3
  33. tccli/services/mps/v20190612/api.json +84 -8
  34. tccli/services/mqtt/mqtt_client.py +658 -75
  35. tccli/services/mqtt/v20240516/api.json +1038 -54
  36. tccli/services/mqtt/v20240516/examples.json +88 -0
  37. tccli/services/ocr/v20181119/api.json +52 -22
  38. tccli/services/ssl/ssl_client.py +122 -16
  39. tccli/services/ssl/v20191205/api.json +448 -2
  40. tccli/services/ssl/v20191205/examples.json +18 -2
  41. tccli/services/tccatalog/v20241024/api.json +22 -0
  42. tccli/services/tcr/v20190924/api.json +2 -2
  43. tccli/services/tmt/v20180321/api.json +1 -1
  44. tccli/services/trtc/v20190722/api.json +49 -51
  45. tccli/services/trtc/v20190722/examples.json +13 -13
  46. {tccli-3.0.1263.1.dist-info → tccli-3.0.1265.1.dist-info}/METADATA +2 -2
  47. {tccli-3.0.1263.1.dist-info → tccli-3.0.1265.1.dist-info}/RECORD +50 -50
  48. {tccli-3.0.1263.1.dist-info → tccli-3.0.1265.1.dist-info}/WHEEL +0 -0
  49. {tccli-3.0.1263.1.dist-info → tccli-3.0.1265.1.dist-info}/entry_points.txt +0 -0
  50. {tccli-3.0.1263.1.dist-info → tccli-3.0.1265.1.dist-info}/license_files/LICENSE +0 -0
tccli/services/cwp/v20180228/api.json CHANGED
@@ -847,13 +847,6 @@
847
847
  "output": "DescribeAttackEventsResponse",
848
848
  "status": "online"
849
849
  },
850
- "DescribeAttackLogs": {
851
- "document": "DescribeAttackEvents 代替\n\n按分页形式展示网络攻击日志列表",
852
- "input": "DescribeAttackLogsRequest",
853
- "name": "网络攻击日志列表(待下线,请使用DescribeAttackEvents代替)",
854
- "output": "DescribeAttackLogsResponse",
855
- "status": "deprecated"
856
- },
857
850
  "DescribeAttackStatistics": {
858
851
  "document": "网络攻击数据统计",
859
852
  "input": "DescribeAttackStatisticsRequest",
@@ -1204,13 +1197,6 @@
1204
1197
  "output": "DescribeClientExceptionResponse",
1205
1198
  "status": "online"
1206
1199
  },
1207
- "DescribeComponentStatistics": {
1208
- "document": "接口已无效\n\n本接口 (DescribeComponentStatistics) 用于获取组件统计列表数据。",
1209
- "input": "DescribeComponentStatisticsRequest",
1210
- "name": "获取组件统计列表",
1211
- "output": "DescribeComponentStatisticsResponse",
1212
- "status": "deprecated"
1213
- },
1214
1200
  "DescribeDefenceEventDetail": {
1215
1201
  "document": "获取漏洞防御事件详情",
1216
1202
  "input": "DescribeDefenceEventDetailRequest",
@@ -13783,62 +13769,6 @@
13783
13769
  ],
13784
13770
  "usage": "both"
13785
13771
  },
13786
- "ComponentStatistics": {
13787
- "document": "组件统计数据。",
13788
- "members": [
13789
- {
13790
- "disabled": false,
13791
- "document": "组件ID。",
13792
- "example": "100010",
13793
- "member": "uint64",
13794
- "name": "Id",
13795
- "output_required": true,
13796
- "type": "int",
13797
- "value_allowed_null": false
13798
- },
13799
- {
13800
- "disabled": false,
13801
- "document": "主机数量。",
13802
- "example": "10",
13803
- "member": "uint64",
13804
- "name": "MachineNum",
13805
- "output_required": true,
13806
- "type": "int",
13807
- "value_allowed_null": false
13808
- },
13809
- {
13810
- "disabled": false,
13811
- "document": "组件名称。",
13812
- "example": "machine-name",
13813
- "member": "string",
13814
- "name": "ComponentName",
13815
- "output_required": true,
13816
- "type": "string",
13817
- "value_allowed_null": false
13818
- },
13819
- {
13820
- "disabled": false,
13821
- "document": "组件类型。\n<li>WEB：Web组件</li>\n<li>SYSTEM：系统组件</li>",
13822
- "example": "WEB",
13823
- "member": "string",
13824
- "name": "ComponentType",
13825
- "output_required": true,
13826
- "type": "string",
13827
- "value_allowed_null": false
13828
- },
13829
- {
13830
- "disabled": false,
13831
- "document": "组件描述。",
13832
- "example": "description",
13833
- "member": "string",
13834
- "name": "Description",
13835
- "output_required": true,
13836
- "type": "string",
13837
- "value_allowed_null": false
13838
- }
13839
- ],
13840
- "usage": "out"
13841
- },
13842
13772
  "CreateBanWhiteListRequest": {
13843
13773
  "document": "CreateBanWhiteList请求参数结构体",
13844
13774
  "members": [
@@ -15081,162 +15011,6 @@
15081
15011
  ],
15082
15012
  "usage": "out"
15083
15013
  },
15084
- "DefendAttackLog": {
15085
- "document": "网络攻击日志",
15086
- "members": [
15087
- {
15088
- "disabled": false,
15089
- "document": "日志ID",
15090
- "example": "10001",
15091
- "member": "uint64",
15092
- "name": "Id",
15093
- "output_required": true,
15094
- "type": "int",
15095
- "value_allowed_null": false
15096
- },
15097
- {
15098
- "disabled": false,
15099
- "document": "客户端ID",
15100
- "example": "93b5fa8f-f5bc-4cf9-8253-d2739e5aa484",
15101
- "member": "string",
15102
- "name": "Uuid",
15103
- "output_required": true,
15104
- "type": "string",
15105
- "value_allowed_null": false
15106
- },
15107
- {
15108
- "disabled": false,
15109
- "document": "来源IP",
15110
- "example": "1.1.1.1",
15111
- "member": "string",
15112
- "name": "SrcIp",
15113
- "output_required": true,
15114
- "type": "string",
15115
- "value_allowed_null": false
15116
- },
15117
- {
15118
- "disabled": false,
15119
- "document": "来源端口",
15120
- "example": "80",
15121
- "member": "uint64",
15122
- "name": "SrcPort",
15123
- "output_required": true,
15124
- "type": "int",
15125
- "value_allowed_null": false
15126
- },
15127
- {
15128
- "disabled": false,
15129
- "document": "攻击方式",
15130
- "example": "attck_method",
15131
- "member": "string",
15132
- "name": "HttpMethod",
15133
- "output_required": true,
15134
- "type": "string",
15135
- "value_allowed_null": false
15136
- },
15137
- {
15138
- "disabled": false,
15139
- "document": "攻击描述",
15140
- "example": "描述",
15141
- "member": "string",
15142
- "name": "HttpCgi",
15143
- "output_required": true,
15144
- "type": "string",
15145
- "value_allowed_null": false
15146
- },
15147
- {
15148
- "disabled": false,
15149
- "document": "攻击参数",
15150
- "example": "header",
15151
- "member": "string",
15152
- "name": "HttpParam",
15153
- "output_required": true,
15154
- "type": "string",
15155
- "value_allowed_null": false
15156
- },
15157
- {
15158
- "disabled": false,
15159
- "document": "威胁类型",
15160
- "example": "tcp",
15161
- "member": "string",
15162
- "name": "VulType",
15163
- "output_required": true,
15164
- "type": "string",
15165
- "value_allowed_null": false
15166
- },
15167
- {
15168
- "disabled": false,
15169
- "document": "攻击时间",
15170
- "example": "2020-01-01 00:00:00",
15171
- "member": "string",
15172
- "name": "CreatedAt",
15173
- "output_required": true,
15174
- "type": "string",
15175
- "value_allowed_null": false
15176
- },
15177
- {
15178
- "disabled": false,
15179
- "document": "目标服务器IP",
15180
- "example": "1.1.1.1",
15181
- "member": "string",
15182
- "name": "MachineIp",
15183
- "output_required": true,
15184
- "type": "string",
15185
- "value_allowed_null": false
15186
- },
15187
- {
15188
- "disabled": false,
15189
- "document": "目标服务器名称",
15190
- "example": "1.1.1.1",
15191
- "member": "string",
15192
- "name": "MachineName",
15193
- "output_required": true,
15194
- "type": "string",
15195
- "value_allowed_null": false
15196
- },
15197
- {
15198
- "disabled": false,
15199
- "document": "目标IP",
15200
- "example": "1.1.1.1",
15201
- "member": "string",
15202
- "name": "DstIp",
15203
- "output_required": true,
15204
- "type": "string",
15205
- "value_allowed_null": false
15206
- },
15207
- {
15208
- "disabled": false,
15209
- "document": "目标端口",
15210
- "example": "8080",
15211
- "member": "uint64",
15212
- "name": "DstPort",
15213
- "output_required": true,
15214
- "type": "int",
15215
- "value_allowed_null": false
15216
- },
15217
- {
15218
- "disabled": false,
15219
- "document": "攻击内容",
15220
- "example": "content",
15221
- "member": "string",
15222
- "name": "HttpContent",
15223
- "output_required": true,
15224
- "type": "string",
15225
- "value_allowed_null": false
15226
- },
15227
- {
15228
- "disabled": false,
15229
- "document": "主机额外信息",
15230
- "example": "{\"WanIP\":\"1.1.1.1\",\"PrivateIP\":\"1.1.1.1\",\"NetworkType\":1,\"NetworkName\":\"vpc-id\",\"InstanceID\":\"ins-id\",\"HostName\":\"hn\"}",
15231
- "member": "MachineExtraInfo",
15232
- "name": "MachineExtraInfo",
15233
- "output_required": true,
15234
- "type": "object",
15235
- "value_allowed_null": false
15236
- }
15237
- ],
15238
- "usage": "out"
15239
- },
15240
15014
  "DeleteAllJavaMemShellsRequest": {
15241
15015
  "document": "DeleteAllJavaMemShells请求参数结构体",
15242
15016
  "members": [
@@ -20320,89 +20094,6 @@
20320
20094
  ],
20321
20095
  "type": "object"
20322
20096
  },
20323
- "DescribeAttackLogsRequest": {
20324
- "document": "DescribeAttackLogs请求参数结构体",
20325
- "members": [
20326
- {
20327
- "disabled": false,
20328
- "document": "返回数量，最大值为100。",
20329
- "example": "10",
20330
- "member": "uint64",
20331
- "name": "Limit",
20332
- "required": false,
20333
- "type": "int"
20334
- },
20335
- {
20336
- "disabled": false,
20337
- "document": "偏移量，默认为0。",
20338
- "example": "0",
20339
- "member": "uint64",
20340
- "name": "Offset",
20341
- "required": false,
20342
- "type": "int"
20343
- },
20344
- {
20345
- "disabled": false,
20346
- "document": "过滤条件。\n<li>HttpMethod - String - 是否必填：否 - 攻击方法(POST|GET)</li>\n<li>DateRange - String - 是否必填：否 - 时间范围(存储最近3个月的数据)，如最近一个月[\"2019-11-17\", \"2019-12-17\"]</li>\n<li>VulType - String 威胁类型 - 是否必填: 否</li>\n<li>SrcIp - String 攻击源IP - 是否必填: 否</li>\n<li>DstIp - String 攻击目标IP - 是否必填: 否</li>\n<li>SrcPort - String 攻击源端口 - 是否必填: 否</li>\n<li>DstPort - String 攻击目标端口 - 是否必填: 否</li>",
20347
- "example": "[]",
20348
- "member": "Filter",
20349
- "name": "Filters",
20350
- "required": false,
20351
- "type": "list"
20352
- },
20353
- {
20354
- "disabled": false,
20355
- "document": "主机安全客户端ID",
20356
- "example": "uuid",
20357
- "member": "string",
20358
- "name": "Uuid",
20359
- "required": false,
20360
- "type": "string"
20361
- },
20362
- {
20363
- "disabled": false,
20364
- "document": "云主机机器ID",
20365
- "example": "quuid",
20366
- "member": "string",
20367
- "name": "Quuid",
20368
- "required": false,
20369
- "type": "string"
20370
- }
20371
- ],
20372
- "type": "object"
20373
- },
20374
- "DescribeAttackLogsResponse": {
20375
- "document": "DescribeAttackLogs返回参数结构体",
20376
- "members": [
20377
- {
20378
- "disabled": false,
20379
- "document": "日志列表\n注意：此字段可能返回 null，表示取不到有效值。",
20380
- "example": "[]",
20381
- "member": "DefendAttackLog",
20382
- "name": "AttackLogs",
20383
- "output_required": true,
20384
- "type": "list",
20385
- "value_allowed_null": true
20386
- },
20387
- {
20388
- "disabled": false,
20389
- "document": "总条数",
20390
- "example": "0",
20391
- "member": "uint64",
20392
- "name": "TotalCount",
20393
- "output_required": true,
20394
- "type": "int",
20395
- "value_allowed_null": false
20396
- },
20397
- {
20398
- "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
20399
- "member": "string",
20400
- "name": "RequestId",
20401
- "type": "string"
20402
- }
20403
- ],
20404
- "type": "object"
20405
- },
20406
20097
  "DescribeAttackStatisticsRequest": {
20407
20098
  "document": "DescribeAttackStatistics请求参数结构体",
20408
20099
  "members": [],
@@ -23684,71 +23375,6 @@
23684
23375
  ],
23685
23376
  "type": "object"
23686
23377
  },
23687
- "DescribeComponentStatisticsRequest": {
23688
- "document": "DescribeComponentStatistics请求参数结构体",
23689
- "members": [
23690
- {
23691
- "disabled": false,
23692
- "document": "返回数量，默认为10，最大值为100。",
23693
- "example": "10",
23694
- "member": "uint64",
23695
- "name": "Limit",
23696
- "required": false,
23697
- "type": "int"
23698
- },
23699
- {
23700
- "disabled": false,
23701
- "document": "偏移量，默认为0。",
23702
- "example": "0",
23703
- "member": "uint64",
23704
- "name": "Offset",
23705
- "required": false,
23706
- "type": "int"
23707
- },
23708
- {
23709
- "disabled": false,
23710
- "document": "过滤条件。\nComponentName - String - 是否必填：否 - 组件名称",
23711
- "example": "[]",
23712
- "member": "Filter",
23713
- "name": "Filters",
23714
- "required": false,
23715
- "type": "list"
23716
- }
23717
- ],
23718
- "type": "object"
23719
- },
23720
- "DescribeComponentStatisticsResponse": {
23721
- "document": "DescribeComponentStatistics返回参数结构体",
23722
- "members": [
23723
- {
23724
- "disabled": false,
23725
- "document": "组件统计列表记录总数。",
23726
- "example": "100",
23727
- "member": "uint64",
23728
- "name": "TotalCount",
23729
- "required": true,
23730
- "type": "int",
23731
- "value_allowed_null": false
23732
- },
23733
- {
23734
- "disabled": false,
23735
- "document": "组件统计列表数据数组。",
23736
- "example": "[]",
23737
- "member": "ComponentStatistics",
23738
- "name": "ComponentStatistics",
23739
- "required": true,
23740
- "type": "list",
23741
- "value_allowed_null": false
23742
- },
23743
- {
23744
- "document": "唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。",
23745
- "member": "string",
23746
- "name": "RequestId",
23747
- "type": "string"
23748
- }
23749
- ],
23750
- "type": "object"
23751
- },
23752
23378
  "DescribeDefenceEventDetailRequest": {
23753
23379
  "document": "DescribeDefenceEventDetail请求参数结构体",
23754
23380
  "members": [
tccli/services/cwp/v20180228/examples.json CHANGED
@@ -968,14 +968,6 @@
968
968
  "title": "网络攻击检测列表"
969
969
  }
970
970
  ],
971
- "DescribeAttackLogs": [
972
- {
973
- "document": "网络攻击日志列表",
974
- "input": "https://cwp.tencentcloudapi.com/?Action=DescribeAttackLogs\n&<公共请求参数>",
975
- "output": "{\n \"Response\": {\n \"AttackLogs\": [\n {\n \"Id\": 1,\n \"Uuid\": \"abc\",\n \"SrcIp\": \"abc\",\n \"SrcPort\": 1,\n \"HttpMethod\": \"abc\",\n \"HttpCgi\": \"abc\",\n \"HttpParam\": \"abc\",\n \"VulType\": \"abc\",\n \"CreatedAt\": \"abc\",\n \"MachineIp\": \"abc\",\n \"MachineName\": \"abc\",\n \"DstIp\": \"abc\",\n \"DstPort\": 1,\n \"HttpContent\": \"abc\",\n \"MachineExtraInfo\": {\n \"WanIP\": \"abc\",\n \"PrivateIP\": \"abc\",\n \"NetworkType\": 0,\n \"NetworkName\": \"abc\",\n \"InstanceID\": \"abc\",\n \"HostName\": \"abc\"\n }\n }\n ],\n \"TotalCount\": 1,\n \"RequestId\": \"abc\"\n }\n}",
976
- "title": "网络攻击日志列表"
977
- }
978
- ],
979
971
  "DescribeAttackStatistics": [
980
972
  {
981
973
  "document": "网络攻击数据统计",
@@ -1382,14 +1374,6 @@
1382
1374
  "title": "示例1"
1383
1375
  }
1384
1376
  ],
1385
- "DescribeComponentStatistics": [
1386
- {
1387
- "document": "获取组件统计列表",
1388
- "input": "https://cwp.tencentcloudapi.com/?Action=DescribeComponentStatistics\n&Limit=10\n&Offset=0\n&<公共请求参数>",
1389
- "output": "{\n \"Response\": {\n \"ComponentStatistics\": [\n {\n \"Id\": 100010,\n \"MachineNum\": 10,\n \"ComponentName\": \"machine-name\",\n \"ComponentType\": \"WEB\",\n \"Description\": \"description\"\n }\n ],\n \"RequestId\": \"354f4ac3-8546-4516-8c8a-69e3ab73aa8a\",\n \"TotalCount\": 100\n }\n}",
1390
- "title": "获取组件统计列表"
1391
- }
1392
- ],
1393
1377
  "DescribeDefenceEventDetail": [
1394
1378
  {
1395
1379
  "document": "",
tccli/services/dsgc/v20190723/api.json CHANGED
@@ -18812,7 +18812,7 @@
18812
18812
  "example": "2204",
18813
18813
  "member": "uint64",
18814
18814
  "name": "ResourceVPort",
18815
- "required": true,
18815
+ "required": false,
18816
18816
  "type": "int"
18817
18817
  },
18818
18818
  {
@@ -18821,7 +18821,7 @@
18821
18821
  "example": "admin",
18822
18822
  "member": "string",
18823
18823
  "name": "UserName",
18824
- "required": true,
18824
+ "required": false,
18825
18825
  "type": "string"
18826
18826
  },
18827
18827
  {
@@ -18830,7 +18830,7 @@
18830
18830
  "example": "pass",
18831
18831
  "member": "string",
18832
18832
  "name": "Password",
18833
- "required": true,
18833
+ "required": false,
18834
18834
  "type": "string"
18835
18835
  },
18836
18836
  {
@@ -18841,6 +18841,15 @@
18841
18841
  "name": "AuthRange",
18842
18842
  "required": false,
18843
18843
  "type": "string"
18844
+ },
18845
+ {
18846
+ "disabled": false,
18847
+ "document": "自建数据资产的名称，支持修改",
18848
+ "example": "我的自建资产",
18849
+ "member": "string",
18850
+ "name": "ResourceName",
18851
+ "required": false,
18852
+ "type": "string"
18844
18853
  }
18845
18854
  ],
18846
18855
  "type": "object"
tccli/services/ess/v20201111/api.json CHANGED
@@ -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![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)<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类型时</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",
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![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)<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",
2082
2082
  "example": "{\"FontColor\":\"255,0,0\",\"FontSize\":12}",
2083
2083
  "member": "string",
2084
2084
  "name": "ComponentExtra",
tccli/services/essbasic/v20210526/api.json CHANGED
@@ -6091,7 +6091,7 @@
6091
6091
  },
6092
6092
  {
6093
6093
  "disabled": false,
6094
- "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![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)<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类型时</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",
6094
+ "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![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)<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",
6095
6095
  "example": "ComponentExtra",
6096
6096
  "member": "string",
6097
6097
  "name": "ComponentExtra",
tccli/services/facefusion/v20220927/api.json CHANGED
@@ -435,7 +435,7 @@
435
435
  },
436
436
  {
437
437
  "disabled": false,
438
- "document": "人脸增强强度。对整个人脸进行增强，增加清晰度，改善质量。当生成的人脸不够清晰，质感不够好的时候可以设置。取值越大增强强度越大。\n取值范围：0-1之间。默认取值1。\n\n该参数仅对SwapModelType（模型类型）取值1-5生效",
438
+ "document": "人脸增强强度。对整个人脸进行增强，增加清晰度，改善质量。当生成的人脸不够清晰，质感不够好的时候可以设置。取值越大增强强度越大。\n取值范围：0-1之间。默认取值0.5。\n\n该参数仅对SwapModelType（模型类型）取值1-5生效",
439
439
  "example": "0.8",
440
440
  "member": "float",
441
441
  "name": "EnhanceRadio",
@@ -446,7 +446,7 @@
446
446
  },
447
447
  {
448
448
  "disabled": false,
449
- "document": "磨皮强度。当生成脸的图像面部显脏时，可进行设置。\n取值范围：0-1之间。默认取值1。\n\n该参数仅对SwapModelType（模型类型）取值1-5生效",
449
+ "document": "磨皮强度。当生成脸的图像面部显脏时，可进行设置。\n取值范围：0-1之间。默认取值0.5。\n\n该参数仅对SwapModelType（模型类型）取值1-5生效",
450
450
  "example": "0.8",
451
451
  "member": "float",
452
452
  "name": "MpRadio",