tccli 3.0.1223.1__py2.py3-none-any.whl → 3.0.1224.1__py2.py3-none-any.whl
Sign up to get free protection for your applications and to get access to all the features.
- tccli/__init__.py +1 -1
- tccli/services/apigateway/apigateway_client.py +136 -30
- tccli/services/apigateway/v20180808/api.json +183 -0
- tccli/services/apigateway/v20180808/examples.json +16 -0
- tccli/services/autoscaling/v20180419/api.json +4 -4
- tccli/services/bi/bi_client.py +106 -0
- tccli/services/bi/v20220105/api.json +355 -0
- tccli/services/bi/v20220105/examples.json +16 -0
- tccli/services/billing/v20180709/api.json +237 -186
- tccli/services/billing/v20180709/examples.json +2 -2
- tccli/services/bpaas/v20181217/api.json +71 -46
- tccli/services/bpaas/v20181217/examples.json +1 -1
- tccli/services/cam/v20190116/api.json +99 -78
- tccli/services/cam/v20190116/examples.json +10 -10
- tccli/services/cdwch/v20200915/api.json +1 -1
- tccli/services/cdwch/v20200915/examples.json +1 -1
- tccli/services/clb/v20180317/examples.json +1 -1
- tccli/services/cloudhsm/v20191112/api.json +324 -320
- tccli/services/cloudhsm/v20191112/examples.json +16 -16
- tccli/services/cls/v20201016/api.json +2 -2
- tccli/services/config/config_client.py +106 -0
- tccli/services/config/v20220802/api.json +364 -0
- tccli/services/config/v20220802/examples.json +16 -0
- tccli/services/ess/v20201111/api.json +1 -1
- tccli/services/essbasic/v20210526/api.json +1 -1
- tccli/services/gwlb/v20240906/api.json +1 -1
- tccli/services/hunyuan/v20230901/api.json +2 -2
- tccli/services/ivld/v20210903/api.json +3 -3
- tccli/services/lcic/lcic_client.py +110 -4
- tccli/services/lcic/v20220817/api.json +297 -2
- tccli/services/lcic/v20220817/examples.json +16 -0
- tccli/services/live/v20180801/api.json +2 -1
- tccli/services/lke/v20231130/api.json +1 -1
- tccli/services/mps/v20190612/api.json +1 -1
- tccli/services/ocr/ocr_client.py +314 -685
- tccli/services/ocr/v20181119/api.json +157 -1206
- tccli/services/ocr/v20181119/examples.json +0 -56
- tccli/services/organization/v20181225/api.json +43 -43
- tccli/services/organization/v20181225/examples.json +2 -2
- tccli/services/organization/v20210331/api.json +516 -508
- tccli/services/organization/v20210331/examples.json +26 -26
- tccli/services/trtc/trtc_client.py +126 -20
- tccli/services/trtc/v20190722/api.json +138 -14
- tccli/services/trtc/v20190722/examples.json +16 -0
- tccli/services/vpc/v20170312/api.json +1 -1
- {tccli-3.0.1223.1.dist-info → tccli-3.0.1224.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1223.1.dist-info → tccli-3.0.1224.1.dist-info}/RECORD +50 -50
- {tccli-3.0.1223.1.dist-info → tccli-3.0.1224.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1223.1.dist-info → tccli-3.0.1224.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1223.1.dist-info → tccli-3.0.1224.1.dist-info}/license_files/LICENSE +0 -0
@@ -1,5 +1,12 @@
|
|
1
1
|
{
|
2
2
|
"actions": {
|
3
|
+
"DescribeDiscoveredResource": {
|
4
|
+
"document": "资源详情",
|
5
|
+
"input": "DescribeDiscoveredResourceRequest",
|
6
|
+
"name": "资源详情",
|
7
|
+
"output": "DescribeDiscoveredResourceResponse",
|
8
|
+
"status": "online"
|
9
|
+
},
|
3
10
|
"ListAggregateConfigRules": {
|
4
11
|
"document": "账号组获取规则列表",
|
5
12
|
"input": "ListAggregateConfigRulesRequest",
|
@@ -14,6 +21,13 @@
|
|
14
21
|
"output": "ListConfigRulesResponse",
|
15
22
|
"status": "online"
|
16
23
|
},
|
24
|
+
"ListDiscoveredResources": {
|
25
|
+
"document": "获取资源列表",
|
26
|
+
"input": "ListDiscoveredResourcesRequest",
|
27
|
+
"name": "获取资源列表",
|
28
|
+
"output": "ListDiscoveredResourcesResponse",
|
29
|
+
"status": "online"
|
30
|
+
},
|
17
31
|
"PutEvaluations": {
|
18
32
|
"document": "上报自定义规则评估结果",
|
19
33
|
"input": "PutEvaluationsRequest",
|
@@ -351,6 +365,141 @@
|
|
351
365
|
],
|
352
366
|
"usage": "out"
|
353
367
|
},
|
368
|
+
"DescribeDiscoveredResourceRequest": {
|
369
|
+
"document": "DescribeDiscoveredResource请求参数结构体",
|
370
|
+
"members": [
|
371
|
+
{
|
372
|
+
"disabled": false,
|
373
|
+
"document": "资源ID",
|
374
|
+
"example": "ins-sada",
|
375
|
+
"member": "string",
|
376
|
+
"name": "ResourceId",
|
377
|
+
"required": true,
|
378
|
+
"type": "string"
|
379
|
+
},
|
380
|
+
{
|
381
|
+
"disabled": false,
|
382
|
+
"document": "资源类型",
|
383
|
+
"example": "QCS::CVM::Instance",
|
384
|
+
"member": "string",
|
385
|
+
"name": "ResourceType",
|
386
|
+
"required": true,
|
387
|
+
"type": "string"
|
388
|
+
},
|
389
|
+
{
|
390
|
+
"disabled": false,
|
391
|
+
"document": "资源地域",
|
392
|
+
"example": "ap-hangzhou",
|
393
|
+
"member": "string",
|
394
|
+
"name": "ResourceRegion",
|
395
|
+
"required": true,
|
396
|
+
"type": "string"
|
397
|
+
}
|
398
|
+
],
|
399
|
+
"type": "object"
|
400
|
+
},
|
401
|
+
"DescribeDiscoveredResourceResponse": {
|
402
|
+
"document": "DescribeDiscoveredResource返回参数结构体",
|
403
|
+
"members": [
|
404
|
+
{
|
405
|
+
"disabled": false,
|
406
|
+
"document": "资源Id\n注意:此字段可能返回 null,表示取不到有效值。",
|
407
|
+
"example": "instance-123",
|
408
|
+
"member": "string",
|
409
|
+
"name": "ResourceId",
|
410
|
+
"output_required": true,
|
411
|
+
"type": "string",
|
412
|
+
"value_allowed_null": true
|
413
|
+
},
|
414
|
+
{
|
415
|
+
"disabled": false,
|
416
|
+
"document": "资源类型\n注意:此字段可能返回 null,表示取不到有效值。",
|
417
|
+
"example": "QCS::CVM::Instance",
|
418
|
+
"member": "string",
|
419
|
+
"name": "ResourceType",
|
420
|
+
"output_required": true,
|
421
|
+
"type": "string",
|
422
|
+
"value_allowed_null": true
|
423
|
+
},
|
424
|
+
{
|
425
|
+
"disabled": false,
|
426
|
+
"document": "资源名\n注意:此字段可能返回 null,表示取不到有效值。",
|
427
|
+
"example": "cvm",
|
428
|
+
"member": "string",
|
429
|
+
"name": "ResourceName",
|
430
|
+
"output_required": true,
|
431
|
+
"type": "string",
|
432
|
+
"value_allowed_null": true
|
433
|
+
},
|
434
|
+
{
|
435
|
+
"disabled": false,
|
436
|
+
"document": "资源地域\n注意:此字段可能返回 null,表示取不到有效值。",
|
437
|
+
"example": "ap-guangzhou",
|
438
|
+
"member": "string",
|
439
|
+
"name": "ResourceRegion",
|
440
|
+
"output_required": true,
|
441
|
+
"type": "string",
|
442
|
+
"value_allowed_null": true
|
443
|
+
},
|
444
|
+
{
|
445
|
+
"disabled": false,
|
446
|
+
"document": "资源可用区\n注意:此字段可能返回 null,表示取不到有效值。",
|
447
|
+
"example": "ap-guangzhou-1",
|
448
|
+
"member": "string",
|
449
|
+
"name": "ResourceZone",
|
450
|
+
"output_required": true,
|
451
|
+
"type": "string",
|
452
|
+
"value_allowed_null": true
|
453
|
+
},
|
454
|
+
{
|
455
|
+
"disabled": false,
|
456
|
+
"document": "资源配置\n注意:此字段可能返回 null,表示取不到有效值。",
|
457
|
+
"example": "qq",
|
458
|
+
"member": "string",
|
459
|
+
"name": "Configuration",
|
460
|
+
"output_required": true,
|
461
|
+
"type": "string",
|
462
|
+
"value_allowed_null": true
|
463
|
+
},
|
464
|
+
{
|
465
|
+
"disabled": false,
|
466
|
+
"document": "资源创建时间\n注意:此字段可能返回 null,表示取不到有效值。",
|
467
|
+
"example": "12332",
|
468
|
+
"member": "string",
|
469
|
+
"name": "ResourceCreateTime",
|
470
|
+
"output_required": true,
|
471
|
+
"type": "string",
|
472
|
+
"value_allowed_null": true
|
473
|
+
},
|
474
|
+
{
|
475
|
+
"disabled": false,
|
476
|
+
"document": "资源标签\n注意:此字段可能返回 null,表示取不到有效值。",
|
477
|
+
"example": "无",
|
478
|
+
"member": "Tag",
|
479
|
+
"name": "Tags",
|
480
|
+
"output_required": true,
|
481
|
+
"type": "list",
|
482
|
+
"value_allowed_null": true
|
483
|
+
},
|
484
|
+
{
|
485
|
+
"disabled": false,
|
486
|
+
"document": "资源更新时间\n注意:此字段可能返回 null,表示取不到有效值。",
|
487
|
+
"example": "无",
|
488
|
+
"member": "string",
|
489
|
+
"name": "UpdateTime",
|
490
|
+
"output_required": true,
|
491
|
+
"type": "string",
|
492
|
+
"value_allowed_null": true
|
493
|
+
},
|
494
|
+
{
|
495
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
496
|
+
"member": "string",
|
497
|
+
"name": "RequestId",
|
498
|
+
"type": "string"
|
499
|
+
}
|
500
|
+
],
|
501
|
+
"type": "object"
|
502
|
+
},
|
354
503
|
"Evaluation": {
|
355
504
|
"document": "自定义规则评估结果",
|
356
505
|
"members": [
|
@@ -407,6 +556,32 @@
|
|
407
556
|
],
|
408
557
|
"usage": "in"
|
409
558
|
},
|
559
|
+
"Filter": {
|
560
|
+
"document": "资源列表筛选",
|
561
|
+
"members": [
|
562
|
+
{
|
563
|
+
"disabled": false,
|
564
|
+
"document": "查询字段名称 资源名称:resourceName 资源ID:resourceId 资源类型:resourceType 资源地域:resourceRegion 删除状态:resourceDelete 0未删除,1已删除 resourceRegionAndZone地域/可用区",
|
565
|
+
"example": "resourceId",
|
566
|
+
"member": "string",
|
567
|
+
"name": "Name",
|
568
|
+
"required": false,
|
569
|
+
"type": "string",
|
570
|
+
"value_allowed_null": false
|
571
|
+
},
|
572
|
+
{
|
573
|
+
"disabled": false,
|
574
|
+
"document": "查询字段值",
|
575
|
+
"example": "cvm17",
|
576
|
+
"member": "string",
|
577
|
+
"name": "Values",
|
578
|
+
"required": false,
|
579
|
+
"type": "list",
|
580
|
+
"value_allowed_null": false
|
581
|
+
}
|
582
|
+
],
|
583
|
+
"usage": "in"
|
584
|
+
},
|
410
585
|
"InputParameter": {
|
411
586
|
"document": "参数值",
|
412
587
|
"members": [
|
@@ -717,6 +892,89 @@
|
|
717
892
|
],
|
718
893
|
"type": "object"
|
719
894
|
},
|
895
|
+
"ListDiscoveredResourcesRequest": {
|
896
|
+
"document": "ListDiscoveredResources请求参数结构体",
|
897
|
+
"members": [
|
898
|
+
{
|
899
|
+
"disabled": false,
|
900
|
+
"document": "每页显示数量",
|
901
|
+
"example": "10",
|
902
|
+
"member": "uint64",
|
903
|
+
"name": "MaxResults",
|
904
|
+
"required": true,
|
905
|
+
"type": "int"
|
906
|
+
},
|
907
|
+
{
|
908
|
+
"disabled": false,
|
909
|
+
"document": "resourceName:资源名 resourceId :资源ID",
|
910
|
+
"example": "无",
|
911
|
+
"member": "Filter",
|
912
|
+
"name": "Filters",
|
913
|
+
"required": false,
|
914
|
+
"type": "list"
|
915
|
+
},
|
916
|
+
{
|
917
|
+
"disabled": false,
|
918
|
+
"document": "标签",
|
919
|
+
"example": " 无",
|
920
|
+
"member": "Tag",
|
921
|
+
"name": "Tags",
|
922
|
+
"required": false,
|
923
|
+
"type": "list"
|
924
|
+
},
|
925
|
+
{
|
926
|
+
"disabled": false,
|
927
|
+
"document": "下一页token",
|
928
|
+
"example": "\"\"",
|
929
|
+
"member": "string",
|
930
|
+
"name": "NextToken",
|
931
|
+
"required": false,
|
932
|
+
"type": "string"
|
933
|
+
},
|
934
|
+
{
|
935
|
+
"disabled": false,
|
936
|
+
"document": "排序方式 asc、desc",
|
937
|
+
"example": "desc",
|
938
|
+
"member": "string",
|
939
|
+
"name": "OrderType",
|
940
|
+
"required": false,
|
941
|
+
"type": "string"
|
942
|
+
}
|
943
|
+
],
|
944
|
+
"type": "object"
|
945
|
+
},
|
946
|
+
"ListDiscoveredResourcesResponse": {
|
947
|
+
"document": "ListDiscoveredResources返回参数结构体",
|
948
|
+
"members": [
|
949
|
+
{
|
950
|
+
"disabled": false,
|
951
|
+
"document": "详情",
|
952
|
+
"example": "无",
|
953
|
+
"member": "ResourceListInfo",
|
954
|
+
"name": "Items",
|
955
|
+
"required": true,
|
956
|
+
"type": "list",
|
957
|
+
"value_allowed_null": false
|
958
|
+
},
|
959
|
+
{
|
960
|
+
"disabled": false,
|
961
|
+
"document": "下一页\n注意:此字段可能返回 null,表示取不到有效值。",
|
962
|
+
"example": "x",
|
963
|
+
"member": "string",
|
964
|
+
"name": "NextToken",
|
965
|
+
"required": true,
|
966
|
+
"type": "string",
|
967
|
+
"value_allowed_null": true
|
968
|
+
},
|
969
|
+
{
|
970
|
+
"document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
|
971
|
+
"member": "string",
|
972
|
+
"name": "RequestId",
|
973
|
+
"type": "string"
|
974
|
+
}
|
975
|
+
],
|
976
|
+
"type": "object"
|
977
|
+
},
|
720
978
|
"PutEvaluationsRequest": {
|
721
979
|
"document": "PutEvaluations请求参数结构体",
|
722
980
|
"members": [
|
@@ -753,6 +1011,112 @@
|
|
753
1011
|
],
|
754
1012
|
"type": "object"
|
755
1013
|
},
|
1014
|
+
"ResourceListInfo": {
|
1015
|
+
"document": "资源列列表信息",
|
1016
|
+
"members": [
|
1017
|
+
{
|
1018
|
+
"disabled": false,
|
1019
|
+
"document": "资源类型",
|
1020
|
+
"example": "cvm",
|
1021
|
+
"member": "string",
|
1022
|
+
"name": "ResourceType",
|
1023
|
+
"required": true,
|
1024
|
+
"type": "string",
|
1025
|
+
"value_allowed_null": false
|
1026
|
+
},
|
1027
|
+
{
|
1028
|
+
"disabled": false,
|
1029
|
+
"document": "资源名称",
|
1030
|
+
"example": "云服务器",
|
1031
|
+
"member": "string",
|
1032
|
+
"name": "ResourceName",
|
1033
|
+
"required": true,
|
1034
|
+
"type": "string",
|
1035
|
+
"value_allowed_null": false
|
1036
|
+
},
|
1037
|
+
{
|
1038
|
+
"disabled": false,
|
1039
|
+
"document": "资源ID",
|
1040
|
+
"example": "ins-4ynwt8x5",
|
1041
|
+
"member": "string",
|
1042
|
+
"name": "ResourceId",
|
1043
|
+
"required": true,
|
1044
|
+
"type": "string",
|
1045
|
+
"value_allowed_null": false
|
1046
|
+
},
|
1047
|
+
{
|
1048
|
+
"disabled": false,
|
1049
|
+
"document": "地域\n注意:此字段可能返回 null,表示取不到有效值。",
|
1050
|
+
"example": "ap-hangzhou",
|
1051
|
+
"member": "string",
|
1052
|
+
"name": "ResourceRegion",
|
1053
|
+
"required": true,
|
1054
|
+
"type": "string",
|
1055
|
+
"value_allowed_null": true
|
1056
|
+
},
|
1057
|
+
{
|
1058
|
+
"disabled": false,
|
1059
|
+
"document": "资源状态\n注意:此字段可能返回 null,表示取不到有效值。",
|
1060
|
+
"example": "Running",
|
1061
|
+
"member": "string",
|
1062
|
+
"name": "ResourceStatus",
|
1063
|
+
"required": true,
|
1064
|
+
"type": "string",
|
1065
|
+
"value_allowed_null": true
|
1066
|
+
},
|
1067
|
+
{
|
1068
|
+
"disabled": false,
|
1069
|
+
"document": "1 :已删除 2:未删除\n注意:此字段可能返回 null,表示取不到有效值。",
|
1070
|
+
"example": "2",
|
1071
|
+
"member": "uint64",
|
1072
|
+
"name": "ResourceDelete",
|
1073
|
+
"required": true,
|
1074
|
+
"type": "int",
|
1075
|
+
"value_allowed_null": true
|
1076
|
+
},
|
1077
|
+
{
|
1078
|
+
"disabled": false,
|
1079
|
+
"document": "资源创建时间\n注意:此字段可能返回 null,表示取不到有效值。",
|
1080
|
+
"example": "2022-10-10 12:56:37",
|
1081
|
+
"member": "string",
|
1082
|
+
"name": "ResourceCreateTime",
|
1083
|
+
"required": true,
|
1084
|
+
"type": "string",
|
1085
|
+
"value_allowed_null": true
|
1086
|
+
},
|
1087
|
+
{
|
1088
|
+
"disabled": false,
|
1089
|
+
"document": "标签信息\n注意:此字段可能返回 null,表示取不到有效值。",
|
1090
|
+
"example": "x",
|
1091
|
+
"member": "Tag",
|
1092
|
+
"name": "Tags",
|
1093
|
+
"required": true,
|
1094
|
+
"type": "list",
|
1095
|
+
"value_allowed_null": true
|
1096
|
+
},
|
1097
|
+
{
|
1098
|
+
"disabled": false,
|
1099
|
+
"document": "可用区\n注意:此字段可能返回 null,表示取不到有效值。",
|
1100
|
+
"example": "ap-hangzhou-3",
|
1101
|
+
"member": "string",
|
1102
|
+
"name": "ResourceZone",
|
1103
|
+
"required": true,
|
1104
|
+
"type": "string",
|
1105
|
+
"value_allowed_null": true
|
1106
|
+
},
|
1107
|
+
{
|
1108
|
+
"disabled": false,
|
1109
|
+
"document": "合规状态\n注意:此字段可能返回 null,表示取不到有效值。",
|
1110
|
+
"example": "COMPLIANT",
|
1111
|
+
"member": "string",
|
1112
|
+
"name": "ComplianceResult",
|
1113
|
+
"required": true,
|
1114
|
+
"type": "string",
|
1115
|
+
"value_allowed_null": true
|
1116
|
+
}
|
1117
|
+
],
|
1118
|
+
"usage": "out"
|
1119
|
+
},
|
756
1120
|
"SourceConditionForManage": {
|
757
1121
|
"document": "管理端规则条件",
|
758
1122
|
"members": [
|
@@ -1,5 +1,13 @@
|
|
1
1
|
{
|
2
2
|
"actions": {
|
3
|
+
"DescribeDiscoveredResource": [
|
4
|
+
{
|
5
|
+
"document": "获取资源详情",
|
6
|
+
"input": "POST / HTTP/1.1\nHost: config.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDiscoveredResource\n<公共请求参数>\n\n{\n \"ResourceId\": \"ins-2avl1cxx\",\n \"ResourceType\": \"QCS::CVM::Instance\",\n \"ResourceRegion\": \"ap-guangzhou\"\n}",
|
7
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"2ea2d804-d278-4631-b04d-70bd40e1a478\",\n \"Configuration\": \"{\\\"InstanceState\\\":\\\"RUNNING\\\",\\\"InstanceName\\\":\\\"未命名\\\",\\\"InstanceId\\\":\\\"ins-111\\\",\\\"InstanceType\\\":\\\"S5.SMALL2\\\",\\\"VirtualPrivateCloud\\\":{\\\"VpcId\\\":\\\"vpc-333\\\",\\\"SubnetId\\\":\\\"subnet-qxupkefw\\\",\\\"AsVpcGateway\\\":false,\\\"PrivateIpAddresses\\\":null,\\\"Ipv6AddressCount\\\":0},\\\"PrivateIpAddresses\\\":[\\\"111\\\"],\\\"PublicIpAddresses\\\":null,\\\"OsName\\\":\\\"TencentOS Server 4 for x86_64\\\",\\\"Memory\\\":2,\\\"CPU\\\":1,\\\"InternetAccessible\\\":{\\\"InternetChargeType\\\":\\\"\\\",\\\"InternetMaxBandwidthOut\\\":0,\\\"PublicIpAssigned\\\":false,\\\"BandwidthPackageId\\\":\\\"\\\"},\\\"ImageId\\\":\\\"img-333\\\",\\\"InstanceChargeType\\\":\\\"PREPAID\\\",\\\"SecurityGroupIds\\\":[\\\"sg-222\\\"],\\\"DataDisks\\\":null,\\\"SystemDisk\\\":{\\\"DiskType\\\":\\\"CLOUD_PREMIUM\\\",\\\"DiskId\\\":\\\"disk-auh4557w\\\"},\\\"ExpiredTime\\\":\\\"2024-12-28T08:07:12Z\\\",\\\"RenewFlag\\\":\\\"NOTIFY_AND_MANUAL_RENEW\\\",\\\"LatestOperation\\\":\\\"\\\",\\\"Placement\\\":{\\\"ProjectId\\\":0},\\\"LatestOperationState\\\":\\\"\\\",\\\"CamRoleName\\\":\\\"\\\"}\",\n \"ResourceCreateTime\": \"2024-11-28 16:07:12\",\n \"ResourceId\": \"ins-2avl1cxx\",\n \"ResourceName\": \"未命名\",\n \"ResourceRegion\": \"ap-guangzhou\",\n \"ResourceType\": \"QCS::CVM::Instance\",\n \"ResourceZone\": \"\",\n \"Tags\": [],\n \"UpdateTime\": \"2024-11-28 16:08:36\"\n }\n}",
|
8
|
+
"title": "获取资源详情"
|
9
|
+
}
|
10
|
+
],
|
3
11
|
"ListAggregateConfigRules": [
|
4
12
|
{
|
5
13
|
"document": "账号组获取规则列表",
|
@@ -16,6 +24,14 @@
|
|
16
24
|
"title": "获取规则列表"
|
17
25
|
}
|
18
26
|
],
|
27
|
+
"ListDiscoveredResources": [
|
28
|
+
{
|
29
|
+
"document": "",
|
30
|
+
"input": "POST / HTTP/1.1\nHost: config.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ListDiscoveredResources\n<公共请求参数>\n\n{\n \"OrderType\": \"xx\",\n \"NextToken\": \"xx\",\n \"MaxResults\": 1,\n \"Filters\": [\n {\n \"Values\": [\n \"xx\"\n ],\n \"Name\": \"xx\"\n }\n ],\n \"Tags\": [\n {\n \"TagKey\": \"xx\",\n \"TagValue\": \"xx\"\n }\n ]\n}",
|
31
|
+
"output": "{\n \"Response\": {\n \"Items\": [\n {\n \"ResourceStatus\": \"xx\",\n \"Tags\": [\n {\n \"TagKey\": \"xx\",\n \"TagValue\": \"xx\"\n }\n ],\n \"ResourceType\": \"xx\",\n \"ResourceId\": \"xx\",\n \"ResourceCreateTime\": 1,\n \"ResourceRegion\": \"xx\",\n \"ResourceName\": \"xx\",\n \"ResourceZone\": \"xx\",\n \"ResourceDelete\": 1,\n \"ComplianceResult\": \"xx\"\n }\n ],\n \"NextToken\": \"xx\",\n \"RequestId\": \"xx\"\n }\n}",
|
32
|
+
"title": "获取资源列表"
|
33
|
+
}
|
34
|
+
],
|
19
35
|
"PutEvaluations": [
|
20
36
|
{
|
21
37
|
"document": "上报自定义规则评估结果",
|
@@ -2046,7 +2046,7 @@
|
|
2046
2046
|
},
|
2047
2047
|
{
|
2048
2048
|
"disabled": false,
|
2049
|
-
"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></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-1,0.7表示70%的透明度,1表示无透明度</li></ul>\n<b>参数样例</b>:`{\"Opacity\":0.7}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置\"IgnoreKeywordError\"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。\n<b>参数样例</b>:` \"{\"IgnoreKeywordError\":1}\"`",
|
2049
|
+
"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></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>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置\"IgnoreKeywordError\"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。\n<b>参数样例</b>:` \"{\"IgnoreKeywordError\":1}\"`",
|
2050
2050
|
"example": "无",
|
2051
2051
|
"member": "string",
|
2052
2052
|
"name": "ComponentExtra",
|
@@ -5870,7 +5870,7 @@
|
|
5870
5870
|
},
|
5871
5871
|
{
|
5872
5872
|
"disabled": false,
|
5873
|
-
"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></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>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置\"IgnoreKeywordError\"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。\n<b>参数样例</b>:` \"{\"IgnoreKeywordError\":1}\"`",
|
5873
|
+
"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></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.6-1,0.7表示70%的透明度,1表示无透明度</li></ul>\n<b>参数样例</b>:`{\"Opacity\":0.7}`\n\n<font color=\"red\">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>\n<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>\n场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置\"IgnoreKeywordError\"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。\n<b>参数样例</b>:` \"{\"IgnoreKeywordError\":1}\"`",
|
5874
5874
|
"example": "ComponentExtra",
|
5875
5875
|
"member": "string",
|
5876
5876
|
"name": "ComponentExtra",
|
@@ -166,7 +166,7 @@
|
|
166
166
|
"members": [
|
167
167
|
{
|
168
168
|
"disabled": false,
|
169
|
-
"document": "模型名称,可选值包括 hunyuan-lite、hunyuan-standard、hunyuan-standard-256K、hunyuan-pro、 hunyuan-code、 hunyuan-role、 hunyuan-functioncall、 hunyuan-vision、 hunyuan-turbo、 hunyuan-turbo-latest、 hunyuan-large。\n各模型介绍请阅读 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 中的说明。\n\n注意:\n不同的模型计费不同,请根据 [购买指南](https://cloud.tencent.com/document/product/1729/97731) 按需调用。",
|
169
|
+
"document": "模型名称,可选值包括 hunyuan-lite、hunyuan-standard、hunyuan-standard-256K、hunyuan-pro、 hunyuan-code、 hunyuan-role、 hunyuan-functioncall、 hunyuan-vision、 hunyuan-turbo、 hunyuan-turbo-latest、 hunyuan-large、 hunyuan-large-longcontext、 hunyuan-turbo-vision。\n各模型介绍请阅读 [产品概述](https://cloud.tencent.com/document/product/1729/104753) 中的说明。\n\n注意:\n不同的模型计费不同,请根据 [购买指南](https://cloud.tencent.com/document/product/1729/97731) 按需调用。",
|
170
170
|
"example": "hunyuan-pro",
|
171
171
|
"member": "string",
|
172
172
|
"name": "Model",
|
@@ -1580,7 +1580,7 @@
|
|
1580
1580
|
},
|
1581
1581
|
{
|
1582
1582
|
"disabled": false,
|
1583
|
-
"document": "多种类型内容(目前支持图片和文本),仅 hunyuan-vision 模型支持\n注意:此字段可能返回 null,表示取不到有效值。",
|
1583
|
+
"document": "多种类型内容(目前支持图片和文本),仅 hunyuan-vision 和 hunyuan-turbo-vision 模型支持\n注意:此字段可能返回 null,表示取不到有效值。",
|
1584
1584
|
"example": "无",
|
1585
1585
|
"member": "Content",
|
1586
1586
|
"name": "Contents",
|
@@ -162,7 +162,7 @@
|
|
162
162
|
"status": "online"
|
163
163
|
},
|
164
164
|
"ImportMedia": {
|
165
|
-
"document": "将URL指向的媒资视频文件导入系统之中。\n\n**请注意,本接口为异步接口**。接口返回MediaId仅代表导入视频任务发起,不代表任务完成,您可调用读接口(DescribeMedia/DescribeMedias)接口查询MediaId\n\nURL字段推荐您使用COS地址,其形式为`https://${Bucket}-${AppId}.cos.${Region}.myqcloud.com/${ObjectKey}`,其中`${Bucket}`为您的COS桶名称,Region为COS桶所在[可用区](https://cloud.tencent.com/document/product/213/6091),`${ObjectKey}`为指向存储在COS桶内的待分析的视频的[ObjectKey](https://cloud.tencent.com/document/product/436/13324)\n\n另外,目前产品也支持使用外部URL地址,但是当传入URL为非COS地址时,需要您指定额外的WriteBackCosPath以供产品回写结果数据。\n\n分析完成后,本产品将在您的`${Bucket}`桶内创建名为`${ObjectKey}_${task-create-time}`的目录(`task-create-time`形式为1970-01-01T08:08:08)并将分析结果将回传回该目录,也即,结构化分析结果(包括图片,JSON等数据)将会写回`https://${Bucket}-${AppId}.cos.${Region}.myqcloud.com/${ObjectKey}_${task-create-time}
|
165
|
+
"document": "将URL指向的媒资视频文件导入系统之中。\n\n**请注意,本接口为异步接口**。接口返回MediaId仅代表导入视频任务发起,不代表任务完成,您可调用读接口(DescribeMedia/DescribeMedias)接口查询MediaId\n\nURL字段推荐您使用COS地址,其形式为`https://${Bucket}-${AppId}.cos.${Region}.myqcloud.com/${ObjectKey}`,其中`${Bucket}`为您的COS桶名称,Region为COS桶所在[可用区](https://cloud.tencent.com/document/product/213/6091),`${ObjectKey}`为指向存储在COS桶内的待分析的视频的[ObjectKey](https://cloud.tencent.com/document/product/436/13324)\n\n另外,目前产品也支持使用外部URL地址,但是当传入URL为非COS地址时,需要您指定额外的WriteBackCosPath以供产品回写结果数据。\n\n分析完成后,本产品将在您的`${Bucket}`桶内创建名为`${ObjectKey}_${task-create-time}`的目录(`task-create-time`形式为1970-01-01T08:08:08)并将分析结果将回传回该目录,也即,结构化分析结果(包括图片,JSON等数据)将会写回`https://${Bucket}-${AppId}.cos.${Region}.myqcloud.com/${ObjectKey}_${task-create-time}`目录",
|
166
166
|
"input": "ImportMediaRequest",
|
167
167
|
"name": "导入媒资文件",
|
168
168
|
"output": "ImportMediaResponse",
|
@@ -2170,10 +2170,10 @@
|
|
2170
2170
|
{
|
2171
2171
|
"disabled": false,
|
2172
2172
|
"document": "媒资文件在系统中的ID",
|
2173
|
-
"example": "\"
|
2173
|
+
"example": "\"media-2aHsU6sj\"",
|
2174
2174
|
"member": "string",
|
2175
2175
|
"name": "MediaId",
|
2176
|
-
"
|
2176
|
+
"output_required": true,
|
2177
2177
|
"type": "string",
|
2178
2178
|
"value_allowed_null": false
|
2179
2179
|
},
|