tccli 3.0.1031.1__py2.py3-none-any.whl → 3.0.1032.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/examples/cdwdoris/v20211228/CreateInstanceNew.md +36 -0
- tccli/examples/cdwdoris/v20211228/DescribeClusterConfigs.md +29 -0
- tccli/examples/cdwdoris/v20211228/DescribeDatabaseAuditDownload.md +33 -0
- tccli/examples/cdwdoris/v20211228/DescribeDatabaseAuditRecords.md +47 -0
- tccli/examples/cdwdoris/v20211228/DescribeInstanceNodesInfo.md +54 -0
- tccli/examples/cdwdoris/v20211228/DescribeInstanceState.md +26 -0
- tccli/examples/cdwdoris/v20211228/DescribeSlowQueryRecords.md +41 -0
- tccli/examples/cdwdoris/v20211228/DescribeSlowQueryRecordsDownload.md +25 -0
- tccli/examples/cdwdoris/v20211228/DestroyInstance.md +23 -0
- tccli/examples/cdwdoris/v20211228/ModifyInstance.md +21 -0
- tccli/examples/cdwdoris/v20211228/ResizeDisk.md +25 -0
- tccli/examples/cdwdoris/v20211228/RestartClusterForNode.md +23 -0
- tccli/examples/cdwdoris/v20211228/ScaleOutInstance.md +25 -0
- tccli/examples/cdwdoris/v20211228/ScaleUpInstance.md +25 -0
- tccli/examples/essbasic/v20210526/DescribeTemplates.md +32 -4
- tccli/examples/mongodb/v20190725/ModifyDBInstanceSpec.md +4 -4
- tccli/examples/tke/v20180525/CreateClusterNodePool.md +2 -0
- tccli/examples/vod/v20180717/DescribeProcedureTemplates.md +3 -18
- tccli/examples/vod/v20180717/DescribeVodDomains.md +1 -0
- tccli/examples/yinsuda/v20220527/DescribeKTVMusicAccompanySegmentUrlVip.md +28 -0
- tccli/examples/yinsuda/v20220527/DescribeVipUserInfo.md +26 -0
- tccli/examples/yinsuda/v20220527/RechargeVip.md +27 -0
- tccli/services/cat/v20180409/api.json +10 -1
- tccli/services/cdwdoris/cdwdoris_client.py +750 -8
- tccli/services/cdwdoris/v20211228/api.json +2462 -494
- tccli/services/cdwdoris/v20211228/examples.json +118 -0
- tccli/services/cls/v20201016/api.json +2 -2
- tccli/services/ess/v20201111/api.json +4 -4
- tccli/services/essbasic/v20210526/api.json +22 -22
- tccli/services/essbasic/v20210526/examples.json +2 -2
- tccli/services/lighthouse/v20200324/api.json +5 -5
- tccli/services/mongodb/v20190725/api.json +11 -11
- tccli/services/mongodb/v20190725/examples.json +2 -2
- tccli/services/monitor/v20180724/api.json +2 -0
- tccli/services/tke/v20180525/api.json +59 -3
- tccli/services/tke/v20180525/examples.json +1 -1
- tccli/services/vod/v20180717/api.json +49 -49
- tccli/services/vod/v20180717/examples.json +2 -2
- tccli/services/vpc/v20170312/api.json +10 -0
- tccli/services/waf/v20180125/api.json +11 -0
- tccli/services/yinsuda/v20220527/api.json +305 -0
- tccli/services/yinsuda/v20220527/examples.json +24 -0
- tccli/services/yinsuda/yinsuda_client.py +175 -16
- {tccli-3.0.1031.1.dist-info → tccli-3.0.1032.1.dist-info}/METADATA +2 -2
- {tccli-3.0.1031.1.dist-info → tccli-3.0.1032.1.dist-info}/RECORD +49 -32
- {tccli-3.0.1031.1.dist-info → tccli-3.0.1032.1.dist-info}/WHEEL +0 -0
- {tccli-3.0.1031.1.dist-info → tccli-3.0.1032.1.dist-info}/entry_points.txt +0 -0
- {tccli-3.0.1031.1.dist-info → tccli-3.0.1032.1.dist-info}/license_files/LICENSE +0 -0
@@ -1,5 +1,37 @@
|
|
1
1
|
{
|
2
2
|
"actions": {
|
3
|
+
"CreateInstanceNew": [
|
4
|
+
{
|
5
|
+
"document": "创建集群",
|
6
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: CreateInstanceNew\n<公共请求参数>\n\n{\n \"InstanceName\": \"test-按量-hazk2节点\",\n \"Zone\": \"ap-beijing-2\",\n \"FeSpec\": {\n \"SpecName\": \"S_4_16_H\",\n \"Count\": 3,\n \"DiskSize\": 200\n },\n \"BeSpec\": {\n \"SpecName\": \"S_4_16_H\",\n \"Count\": 3,\n \"DiskSize\": 1000\n },\n \"HaFlag\": true,\n \"UserVPCId\": \"vpc-8visjoh9\",\n \"UserSubnetId\": \"subnet-03ij1dki\",\n \"ProductVersion\": \"1.2\",\n \"DorisUserPwd\": \"ujA7xa2*1\",\n \"ChargeProperties\": {\n \"ChargeType\": \"POSTPAID_BY_HOUR\"\n }\n}",
|
7
|
+
"output": "{\n \"Response\": {\n \"InstanceId\": \"cdwdoris-aijqera\",\n \"FlowId\": \"1231\",\n \"RequestId\": \"lweinasd-28kamasd-xasdas\",\n \"ErrorMsg\": \"\"\n }\n}",
|
8
|
+
"title": "集群创建示例"
|
9
|
+
}
|
10
|
+
],
|
11
|
+
"DescribeClusterConfigs": [
|
12
|
+
{
|
13
|
+
"document": "在xml方式下修改配置文件内容时,获取集群配置文件内容",
|
14
|
+
"input": "https://cdwdoris.tencentcloudapi.com/\n?Action=DescribeClusterConfigs\n&InstanceId=cdwch-xxxx\n&<公共请求参数>",
|
15
|
+
"output": "{\n \"Response\": {\n \"ClusterConfList\": [\n {\n \"NeedRestart\": 1,\n \"OriParam\": \"ss=sc\",\n \"KeyConf\": \"ss=sc\",\n \"FileConf\": \"ss=sc\",\n \"FileName\": \"test\"\n }\n ],\n \"RequestId\": \"xx-aa\"\n }\n}",
|
16
|
+
"title": "获取集群配置文件内容"
|
17
|
+
}
|
18
|
+
],
|
19
|
+
"DescribeDatabaseAuditDownload": [
|
20
|
+
{
|
21
|
+
"document": "下载数据库审计日志",
|
22
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDatabaseAuditDownload\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"StartTime\": \"abc\",\n \"EndTime\": \"abc\",\n \"PageSize\": 0,\n \"PageNum\": 0,\n \"OrderType\": \"abc\",\n \"User\": \"abc\",\n \"DbName\": \"abc\",\n \"SqlType\": \"abc\",\n \"Sql\": \"abc\",\n \"Users\": [\n \"abc\"\n ],\n \"DbNames\": [\n \"abc\"\n ],\n \"SqlTypes\": [\n \"abc\"\n ]\n}",
|
23
|
+
"output": "{\n \"Response\": {\n \"CosUrl\": \"abc\",\n \"RequestId\": \"abc\"\n }\n}",
|
24
|
+
"title": "DescribeDatabaseAuditDownload"
|
25
|
+
}
|
26
|
+
],
|
27
|
+
"DescribeDatabaseAuditRecords": [
|
28
|
+
{
|
29
|
+
"document": "获取数据库审计记录",
|
30
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeDatabaseAuditRecords\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"StartTime\": \"abc\",\n \"EndTime\": \"abc\",\n \"PageSize\": 0,\n \"PageNum\": 0,\n \"OrderType\": \"abc\",\n \"User\": \"abc\",\n \"DbName\": \"abc\",\n \"SqlType\": \"abc\",\n \"Sql\": \"abc\",\n \"Users\": [\n \"abc\"\n ],\n \"DbNames\": [\n \"abc\"\n ],\n \"SqlTypes\": [\n \"abc\"\n ]\n}",
|
31
|
+
"output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"SlowQueryRecords\": {\n \"OsUser\": \"abc\",\n \"InitialQueryId\": \"abc\",\n \"Sql\": \"abc\",\n \"QueryStartTime\": \"abc\",\n \"DurationMs\": 0,\n \"ReadRows\": 0,\n \"ResultRows\": 0,\n \"ResultBytes\": 1,\n \"MemoryUsage\": 0,\n \"InitialAddress\": \"abc\",\n \"DbName\": \"abc\",\n \"SqlType\": \"abc\"\n },\n \"RequestId\": \"abc\"\n }\n}",
|
32
|
+
"title": "DescribeDatabaseAuditRecords"
|
33
|
+
}
|
34
|
+
],
|
3
35
|
"DescribeInstance": [
|
4
36
|
{
|
5
37
|
"document": "根据集群ID查询某个集群的具体信息",
|
@@ -16,6 +48,28 @@
|
|
16
48
|
"title": "获取集群节点信息列表"
|
17
49
|
}
|
18
50
|
],
|
51
|
+
"DescribeInstanceNodesInfo": [
|
52
|
+
{
|
53
|
+
"document": "查询节点角色",
|
54
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstanceNodesInfo\n<公共请求参数>\n\n{\n \"InstanceID\": \"abc\"\n}",
|
55
|
+
"output": "{\n \"Response\": {\n \"BeNodes\": [\n \"abc\"\n ],\n \"FeNodes\": [\n \"abc\"\n ],\n \"FeMaster\": \"abc\",\n \"RequestId\": \"abc\"\n }\n}",
|
56
|
+
"title": "查询节点角色"
|
57
|
+
},
|
58
|
+
{
|
59
|
+
"document": "",
|
60
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstanceNodesInfo\n<公共请求参数>\n\n{\n \"InstanceID\": \"abc\"\n}",
|
61
|
+
"output": "{\n \"Response\": {\n \"BeNodes\": [\n \"abc\"\n ],\n \"FeNodes\": [\n \"abc\"\n ],\n \"FeMaster\": \"abc\",\n \"RequestId\": \"abc\"\n }\n}",
|
62
|
+
"title": "查询节点信息"
|
63
|
+
}
|
64
|
+
],
|
65
|
+
"DescribeInstanceState": [
|
66
|
+
{
|
67
|
+
"document": "需要展现集群状态以及操作进度",
|
68
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeInstanceState\n<公共请求参数>\n\n{\n \"InstanceId\": \"cdwch-exs8Mnql\"\n}",
|
69
|
+
"output": "{\n \"Response\": {\n \"InstanceState\": \"Serving\",\n \"InstanceStateDesc\": \"运行中\",\n \"FlowCreateTime\": \"\",\n \"FlowName\": \"\",\n \"FlowProgress\": 0,\n \"FlowMsg\": \"创建流程失败\",\n \"RequestId\": \"xxxx-xxxx-xxxx-xxxx\"\n }\n}",
|
70
|
+
"title": "获取集群状态"
|
71
|
+
}
|
72
|
+
],
|
19
73
|
"DescribeInstances": [
|
20
74
|
{
|
21
75
|
"document": "获取某个用户下所有的集群列表信息",
|
@@ -23,6 +77,70 @@
|
|
23
77
|
"output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"InstancesList\": [\n {\n \"InstanceId\": \"abc\",\n \"InstanceName\": \"abc\",\n \"Status\": \"abc\",\n \"Version\": \"abc\",\n \"Region\": \"abc\",\n \"Zone\": \"abc\",\n \"VpcId\": \"abc\",\n \"SubnetId\": \"abc\",\n \"PayMode\": \"abc\",\n \"CreateTime\": \"abc\",\n \"ExpireTime\": \"abc\",\n \"MasterSummary\": {\n \"Spec\": \"abc\",\n \"NodeSize\": 0,\n \"Core\": 0,\n \"Memory\": 0,\n \"Disk\": 0,\n \"DiskType\": \"abc\",\n \"DiskDesc\": \"abc\",\n \"AttachCBSSpec\": {\n \"DiskType\": \"abc\",\n \"DiskSize\": 0,\n \"DiskCount\": 0,\n \"DiskDesc\": \"abc\"\n },\n \"SubProductType\": \"abc\",\n \"SpecCore\": 0,\n \"SpecMemory\": 0,\n \"DiskCount\": 0,\n \"Encrypt\": 0,\n \"MaxDiskSize\": 0\n },\n \"CoreSummary\": {\n \"Spec\": \"abc\",\n \"NodeSize\": 0,\n \"Core\": 0,\n \"Memory\": 0,\n \"Disk\": 0,\n \"DiskType\": \"abc\",\n \"DiskDesc\": \"abc\",\n \"AttachCBSSpec\": {\n \"DiskType\": \"abc\",\n \"DiskSize\": 0,\n \"DiskCount\": 0,\n \"DiskDesc\": \"abc\"\n },\n \"SubProductType\": \"abc\",\n \"SpecCore\": 0,\n \"SpecMemory\": 0,\n \"DiskCount\": 0,\n \"Encrypt\": 0,\n \"MaxDiskSize\": 0\n },\n \"HA\": \"abc\",\n \"HaType\": 0,\n \"AccessInfo\": \"abc\",\n \"Id\": 0,\n \"RegionId\": 0,\n \"ZoneDesc\": \"abc\",\n \"FlowMsg\": \"abc\",\n \"StatusDesc\": \"abc\",\n \"RenewFlag\": true,\n \"Tags\": [\n {\n \"TagKey\": \"abc\",\n \"TagValue\": \"abc\"\n }\n ],\n \"Monitor\": \"abc\",\n \"HasClsTopic\": true,\n \"ClsTopicId\": \"abc\",\n \"ClsLogSetId\": \"abc\",\n \"EnableXMLConfig\": 0,\n \"RegionDesc\": \"abc\",\n \"Eip\": \"abc\",\n \"CosMoveFactor\": 0,\n \"Kind\": \"abc\",\n \"CosBucketName\": \"abc\",\n \"CanAttachCbs\": true,\n \"BuildVersion\": \"abc\",\n \"Components\": \"abc\"\n }\n ],\n \"RequestId\": \"abc\"\n }\n}",
|
24
78
|
"title": "获取实例列表"
|
25
79
|
}
|
80
|
+
],
|
81
|
+
"DescribeSlowQueryRecords": [
|
82
|
+
{
|
83
|
+
"document": "慢查询",
|
84
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSlowQueryRecords\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"QueryDurationMs\": 0,\n \"StartTime\": \"abc\",\n \"EndTime\": \"abc\",\n \"PageSize\": 0,\n \"PageNum\": 0,\n \"DurationMs\": \"abc\"\n}",
|
85
|
+
"output": "{\n \"Response\": {\n \"TotalCount\": 0,\n \"SlowQueryRecords\": [\n {\n \"OsUser\": \"abc\",\n \"InitialQueryId\": \"abc\",\n \"Sql\": \"abc\",\n \"QueryStartTime\": \"abc\",\n \"DurationMs\": 0,\n \"ReadRows\": 0,\n \"ResultRows\": 0,\n \"ResultBytes\": 1,\n \"MemoryUsage\": 0,\n \"InitialAddress\": \"abc\"\n }\n ],\n \"RequestId\": \"abc\"\n }\n}",
|
86
|
+
"title": "DescribeSlowQueryRecords"
|
87
|
+
}
|
88
|
+
],
|
89
|
+
"DescribeSlowQueryRecordsDownload": [
|
90
|
+
{
|
91
|
+
"document": "下载慢查询文件",
|
92
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeSlowQueryRecordsDownload\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"QueryDurationMs\": 0,\n \"StartTime\": \"abc\",\n \"EndTime\": \"abc\",\n \"DurationMs\": \"abc\"\n}",
|
93
|
+
"output": "{\n \"Response\": {\n \"CosUrl\": \"abc\",\n \"RequestId\": \"abc\"\n }\n}",
|
94
|
+
"title": "DescribeSlowQueryRecordsDownload"
|
95
|
+
}
|
96
|
+
],
|
97
|
+
"DestroyInstance": [
|
98
|
+
{
|
99
|
+
"document": "",
|
100
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DestroyInstance\n<公共请求参数>\n\n{\n \"InstanceId\": \"cdwdoris-auqej7a\"\n}",
|
101
|
+
"output": "{\n \"Response\": {\n \"FlowId\": \"1231\",\n \"InstanceId\": \"cdwdoris-auqej7a\",\n \"ErrorMsg\": \"\",\n \"RequestId\": \"xasdfkqe2-a12q29-axdfas\"\n }\n}",
|
102
|
+
"title": "集群销毁示例"
|
103
|
+
}
|
104
|
+
],
|
105
|
+
"ModifyInstance": [
|
106
|
+
{
|
107
|
+
"document": "用户修改实例名称",
|
108
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ModifyInstance\n<公共请求参数>\n\n{\n \"InstanceId\": \"cdwch-12345678\",\n \"InstanceName\": \"cdwch-test\"\n}",
|
109
|
+
"output": "{\n \"Response\": {\n \"RequestId\": \"xxxx-xxxx\"\n }\n}",
|
110
|
+
"title": "修改实例信息"
|
111
|
+
}
|
112
|
+
],
|
113
|
+
"ResizeDisk": [
|
114
|
+
{
|
115
|
+
"document": "",
|
116
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ResizeDisk\n<公共请求参数>\n\n{\n \"InstanceId\": \"cdwdoris-asdfxw\",\n \"Type\": \"CORE\",\n \"DiskSize\": 3000\n}",
|
117
|
+
"output": "{\n \"Response\": {\n \"FlowId\": \"1231\",\n \"InstanceId\": \"cdwch-auqej7a\",\n \"ErrorMsg\": \"\",\n \"RequestId\": \"xasdfkqe2-a12q29-axdfas\"\n }\n}",
|
118
|
+
"title": "云盘扩容示例"
|
119
|
+
}
|
120
|
+
],
|
121
|
+
"RestartClusterForNode": [
|
122
|
+
{
|
123
|
+
"document": "",
|
124
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: RestartClusterForNode\n<公共请求参数>\n\n{\n \"InstanceId\": \"abc\",\n \"ConfigName\": \"abc\"\n}",
|
125
|
+
"output": "{\n \"Response\": {\n \"FlowId\": 0,\n \"ErrorMsg\": \"abc\",\n \"RequestId\": \"abc\"\n }\n}",
|
126
|
+
"title": "test"
|
127
|
+
}
|
128
|
+
],
|
129
|
+
"ScaleOutInstance": [
|
130
|
+
{
|
131
|
+
"document": "",
|
132
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ScaleOutInstance\n<公共请求参数>\n\n{\n \"InstanceId\": \"cdwdoris-xqewrqx\",\n \"Type\": \"MASTER\",\n \"NodeCount\": 5\n}",
|
133
|
+
"output": "{\n \"Response\": {\n \"FlowId\": \"1231\",\n \"InstanceId\": \"cdwdoris-xqewrqx\",\n \"ErrorMsg\": \"\",\n \"RequestId\": \"xasdfkqe2-a12q29-axdfas\"\n }\n}",
|
134
|
+
"title": "水平扩容示例"
|
135
|
+
}
|
136
|
+
],
|
137
|
+
"ScaleUpInstance": [
|
138
|
+
{
|
139
|
+
"document": "",
|
140
|
+
"input": "POST / HTTP/1.1\nHost: cdwdoris.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: ScaleUpInstance\n<公共请求参数>\n\n{\n \"InstanceId\": \"cdwdoris-xad3fa9\",\n \"SpecName\": \"S_8_32_H\",\n \"Type\": \"CORE\"\n}",
|
141
|
+
"output": "{\n \"Response\": {\n \"FlowId\": \"1231\",\n \"InstanceId\": \"cdwch-auqej7a\",\n \"ErrorMsg\": \"\",\n \"RequestId\": \"xasdfkqe2-a12q29-axdfas\"\n }\n}",
|
142
|
+
"title": "节点垂直变配示例"
|
143
|
+
}
|
26
144
|
]
|
27
145
|
},
|
28
146
|
"version": "1.0"
|
@@ -11323,8 +11323,8 @@
|
|
11323
11323
|
},
|
11324
11324
|
{
|
11325
11325
|
"disabled": false,
|
11326
|
-
"document": "指标时间戳,默认值为SQL查询时间范围的左侧时间点,您也可以指定其他字段(类型为uinx
|
11327
|
-
"example": "unix_ts",
|
11326
|
+
"document": "指标时间戳,默认值为SQL查询时间范围的左侧时间点,您也可以指定其他字段(类型为uinx时间、TimeStamp,精度毫秒)为指标时间戳。",
|
11327
|
+
"example": "unix_ts,或者TimeStamp 2021-07-15T17:11:56.735+08:00",
|
11328
11328
|
"member": "string",
|
11329
11329
|
"name": "CustomTime",
|
11330
11330
|
"output_required": false,
|
@@ -36,7 +36,7 @@
|
|
36
36
|
"status": "online"
|
37
37
|
},
|
38
38
|
"CreateBatchQuickSignUrl": {
|
39
|
-
"document": "该接口用于发起合同后,生成个人用户的批量签署链接, 暂时不支持企业端签署。\n**注意:**\n1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)。\n2. 该接口可生成批量签署链接的C
|
39
|
+
"document": "该接口用于发起合同后,生成个人用户的批量签署链接, 暂时不支持企业端签署。\n**注意:**\n1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)。\n2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**,**不支持填写控件** 。\n3. 请确保C端签署人在批量签署合同中**为待签署状态**,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。\n4. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。\n5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。\n跳转到小程序的实现,参考微信官方文档(分为<a href=\"https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html\">全屏</a>、<a href=\"https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html\">半屏</a>两种方式),如何配置也可以请参考: <a href=\"https://qian.tencent.com/developers/company/openwxminiprogram\">跳转电子签小程序配置</a>。\n6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href=\"https://cloud.tencent.com/document/product/1007/61076\">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。",
|
40
40
|
"input": "CreateBatchQuickSignUrlRequest",
|
41
41
|
"name": "获取H5批量签署链接",
|
42
42
|
"output": "CreateBatchQuickSignUrlResponse",
|
@@ -696,7 +696,7 @@
|
|
696
696
|
},
|
697
697
|
{
|
698
698
|
"disabled": false,
|
699
|
-
"document": "签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得\n\n
|
699
|
+
"document": "签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得\n\n注: \n如果传进来的<font color=\"red\">UserId已经实名, 则忽略ApproverName,ApproverIdCardType,ApproverIdCardNumber,ApproverMobile这四个入参</font>(会用此UserId实名的身份证和登录的手机号覆盖)",
|
700
700
|
"example": "无",
|
701
701
|
"member": "string",
|
702
702
|
"name": "UserId",
|
@@ -1981,7 +1981,7 @@
|
|
1981
1981
|
},
|
1982
1982
|
{
|
1983
1983
|
"disabled": false,
|
1984
|
-
"document": "指定批量签署合同的签名类型,可传递以下值:\n<ul><li>**0**:手写签名(默认)</li>\n<li>**1**:OCR楷体</li>\n<li>**2**:姓名印章</li>\n<li>**3**:图片印章</li>\n<li>**4**:系统签名</li></ul>\n注:\n<ul><li>默认情况下,签名类型为手写签名</li>\n<li>您可以传递多种值,表示可用多种签名类型。</li
|
1984
|
+
"document": "指定批量签署合同的签名类型,可传递以下值:\n<ul><li>**0**:手写签名(默认)</li>\n<li>**1**:OCR楷体</li>\n<li>**2**:姓名印章</li>\n<li>**3**:图片印章</li>\n<li>**4**:系统签名</li></ul>\n注:\n<ul><li>默认情况下,签名类型为手写签名</li>\n<li>您可以传递多种值,表示可用多种签名类型。</li>\n<li>该参数会覆盖您合同中的签名类型,若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit),请将这些签名类型赋予此参数</li>\n</ul>",
|
1985
1985
|
"example": "[0, 1, 2, 3, 4]",
|
1986
1986
|
"member": "int64",
|
1987
1987
|
"name": "SignatureTypes",
|
@@ -2292,7 +2292,7 @@
|
|
2292
2292
|
},
|
2293
2293
|
{
|
2294
2294
|
"disabled": false,
|
2295
|
-
"document": "电子文档的填写控件的填充内容。具体方式可以参考[FormField](https://qian.tencent.com/developers/companyApis/dataTypes/#formfield)结构体的定义。\n<ul>\n<li>支持自动签传递印章,可通过指定自动签控件id,指定印章id来完成</li>\n</ul>\n注:只有在控制台编辑模板时,<font color=\"red\">归属给发起方</font>的填写控件(如下图)才能在创建文档的时候进行内容填充。\n",
|
2295
|
+
"document": "电子文档的填写控件的填充内容。具体方式可以参考[FormField](https://qian.tencent.com/developers/companyApis/dataTypes/#formfield)结构体的定义。\n<ul>\n<li>支持自动签传递印章,可通过指定自动签控件id,指定印章id来完成</li>\n<li>附件控件支持传入图片、文件资源id,并将内容合成到合同文件中。支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt、pdf。需要注意如果传入的资源类型都是图片类型,图片资源会放置在合同文件的末尾,如果传入的资源有非图片类型资源,会将资源放置在附件控件所在页面的下一页。</li>\n</ul>\n注:只有在控制台编辑模板时,<font color=\"red\">归属给发起方</font>的填写控件(如下图)才能在创建文档的时候进行内容填充。\n",
|
2296
2296
|
"example": "无",
|
2297
2297
|
"member": "FormField",
|
2298
2298
|
"name": "FormFields",
|
@@ -36,7 +36,7 @@
|
|
36
36
|
"status": "online"
|
37
37
|
},
|
38
38
|
"ChannelCreateBatchQuickSignUrl": {
|
39
|
-
"document": "该接口用于发起合同后,生成个人用户的批量签署链接, 暂时不支持企业端签署。\n**注意**:\n1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=PERSON)。\n2. 该接口可生成批量签署链接的C
|
39
|
+
"document": "该接口用于发起合同后,生成个人用户的批量签署链接, 暂时不支持企业端签署。\n**注意**:\n1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=PERSON)。\n2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**,**不支持填写控件** 。\n3. 请确保C端签署人在批量签署合同中**为待签署状态**,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。\n4. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。\n5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。\n跳转到小程序的实现,参考微信官方文档(分为<a href=\"https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html\">全屏</a>、<a href=\"https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html\">半屏</a>两种方式),如何配置也可以请参考: <a href=\"https://qian.tencent.com/developers/company/openwxminiprogram\">跳转电子签小程序配置</a>。\n6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href=\"https://cloud.tencent.com/document/product/1007/61076\">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。",
|
40
40
|
"input": "ChannelCreateBatchQuickSignUrlRequest",
|
41
41
|
"name": "获取H5批量签署链接",
|
42
42
|
"output": "ChannelCreateBatchQuickSignUrlResponse",
|
@@ -386,7 +386,7 @@
|
|
386
386
|
"status": "online"
|
387
387
|
},
|
388
388
|
"DescribeChannelSealPolicyWorkflowUrl": {
|
389
|
-
"document": "
|
389
|
+
"document": "制定渠道分支客户的印刷申请审批微型应用程序链接,链接模式(通过H5触发微型应用程序或通过APP跳转进行查看)。\n此刻,代理参数中的OpenId 必须为审批者的openId,生成的链接必须由该用户启动,其他用户则无审批权限。",
|
390
390
|
"input": "DescribeChannelSealPolicyWorkflowUrlRequest",
|
391
391
|
"name": "生成渠道子客用印申请审批链接",
|
392
392
|
"output": "DescribeChannelSealPolicyWorkflowUrlResponse",
|
@@ -1634,7 +1634,7 @@
|
|
1634
1634
|
},
|
1635
1635
|
{
|
1636
1636
|
"disabled": false,
|
1637
|
-
"document": "指定批量签署合同的签名类型,可传递以下值:\n<ul><li>**0**:手写签名(默认)</li>\n<li>**1**:OCR楷体</li>\n<li>**2**:姓名印章</li>\n<li>**3**:图片印章</li>\n<li>**4**:系统签名</li></ul>\n注:\n<ul><li>默认情况下,签名类型为手写签名</li>\n<li>您可以传递多种值,表示可用多种签名类型。</li></ul>",
|
1637
|
+
"document": "指定批量签署合同的签名类型,可传递以下值:\n<ul><li>**0**:手写签名(默认)</li>\n<li>**1**:OCR楷体</li>\n<li>**2**:姓名印章</li>\n<li>**3**:图片印章</li>\n<li>**4**:系统签名</li></ul>\n注:\n<ul><li>默认情况下,签名类型为手写签名</li>\n<li>您可以传递多种值,表示可用多种签名类型。</li>\n<li>该参数会覆盖您合同中的签名类型,若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit),请将这些签名类型赋予此参数</li></ul>",
|
1638
1638
|
"example": "[0, 1, 2, 3, 4]",
|
1639
1639
|
"member": "int64",
|
1640
1640
|
"name": "SignatureTypes",
|
@@ -6463,7 +6463,7 @@
|
|
6463
6463
|
},
|
6464
6464
|
{
|
6465
6465
|
"disabled": false,
|
6466
|
-
"document": "第三方平台子客企业员工的标识OpenId,GenerateType为\"CHANNEL\"时可用,指定到具体参与人,
|
6466
|
+
"document": "第三方平台子客企业员工的标识OpenId,GenerateType为\"CHANNEL\"时可用,指定到具体参与人, 仅展示已经实名的经办人信息\n\n注: \n如果传进来的<font color=\"red\">OpenId已经实名并且加入企业, 则忽略Name,IdCardType,IdCardNumber,Mobile这四个入参</font>(会用此OpenId实名的身份证和登录的手机号覆盖)",
|
6467
6467
|
"example": "n9527",
|
6468
6468
|
"member": "string",
|
6469
6469
|
"name": "OpenId",
|
@@ -7293,7 +7293,7 @@
|
|
7293
7293
|
},
|
7294
7294
|
{
|
7295
7295
|
"disabled": false,
|
7296
|
-
"document": "是否获取模板预览链接。\n\n<ul><li>**false**:不获取(默认)</li>\n<li>**true**:获取</li></ul>\n\n设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。\n
|
7296
|
+
"document": "是否获取模板预览链接。\n\n<ul><li>**false**:不获取(默认)</li>\n<li>**true**:获取</li></ul>\n\n设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。\n",
|
7297
7297
|
"example": "无",
|
7298
7298
|
"member": "bool",
|
7299
7299
|
"name": "WithPreviewUrl",
|
@@ -7944,7 +7944,7 @@
|
|
7944
7944
|
},
|
7945
7945
|
{
|
7946
7946
|
"disabled": false,
|
7947
|
-
"document": "第三方平台子客企业员工的唯一标识,长度不能超过64,只能由字母和数字组成\n\n
|
7947
|
+
"document": "第三方平台子客企业员工的唯一标识,长度不能超过64,只能由字母和数字组成\n\n当签署方为同一第三方平台下的员工时,该字段若不指定,则发起【待领取】的流程\n\n注: \n如果传进来的<font color=\"red\">OpenId已经实名并且加入企业, 则忽略Name,IdCardType,IdCardNumber,Mobile这四个入参</font>(会用此OpenId实名的身份证和登录的手机号覆盖)",
|
7948
7948
|
"example": "userdianziqian",
|
7949
7949
|
"member": "string",
|
7950
7950
|
"name": "OpenId",
|
@@ -10727,7 +10727,7 @@
|
|
10727
10727
|
{
|
10728
10728
|
"disabled": false,
|
10729
10729
|
"document": "模板ID,模板的唯一标识",
|
10730
|
-
"example": "
|
10730
|
+
"example": "yDSLKUUckpoqt3vzUP7DfuSBwaJfz7M1",
|
10731
10731
|
"member": "string",
|
10732
10732
|
"name": "TemplateId",
|
10733
10733
|
"output_required": true,
|
@@ -10737,7 +10737,7 @@
|
|
10737
10737
|
{
|
10738
10738
|
"disabled": false,
|
10739
10739
|
"document": "模板名",
|
10740
|
-
"example": "
|
10740
|
+
"example": "西红柿采购模板",
|
10741
10741
|
"member": "string",
|
10742
10742
|
"name": "TemplateName",
|
10743
10743
|
"output_required": true,
|
@@ -10747,7 +10747,7 @@
|
|
10747
10747
|
{
|
10748
10748
|
"disabled": false,
|
10749
10749
|
"document": "模板描述信息",
|
10750
|
-
"example": "
|
10750
|
+
"example": "2023年西红柿采购模板",
|
10751
10751
|
"member": "string",
|
10752
10752
|
"name": "Description",
|
10753
10753
|
"output_required": true,
|
@@ -10766,7 +10766,7 @@
|
|
10766
10766
|
},
|
10767
10767
|
{
|
10768
10768
|
"disabled": false,
|
10769
|
-
"document": "
|
10769
|
+
"document": "此模块需要签署的各个参与方的角色列表。RecipientId标识每个参与方角色对应的唯一标识符,用于确定此角色的信息。",
|
10770
10770
|
"example": "无",
|
10771
10771
|
"member": "Recipient",
|
10772
10772
|
"name": "Recipients",
|
@@ -10776,7 +10776,7 @@
|
|
10776
10776
|
},
|
10777
10777
|
{
|
10778
10778
|
"disabled": false,
|
10779
|
-
"document": "
|
10779
|
+
"document": "此模版中的签署控件列表",
|
10780
10780
|
"example": "无",
|
10781
10781
|
"member": "Component",
|
10782
10782
|
"name": "SignComponents",
|
@@ -10807,7 +10807,7 @@
|
|
10807
10807
|
{
|
10808
10808
|
"disabled": false,
|
10809
10809
|
"document": "模板的创建者信息,电子签系统用户ID",
|
10810
|
-
"example": "
|
10810
|
+
"example": "锈铁",
|
10811
10811
|
"member": "string",
|
10812
10812
|
"name": "Creator",
|
10813
10813
|
"output_required": true,
|
@@ -10817,7 +10817,7 @@
|
|
10817
10817
|
{
|
10818
10818
|
"disabled": false,
|
10819
10819
|
"document": "模板创建的时间戳,格式为Unix标准时间戳(秒)",
|
10820
|
-
"example": "
|
10820
|
+
"example": "1699259970",
|
10821
10821
|
"member": "int64",
|
10822
10822
|
"name": "CreatedOn",
|
10823
10823
|
"output_required": true,
|
@@ -10826,8 +10826,8 @@
|
|
10826
10826
|
},
|
10827
10827
|
{
|
10828
10828
|
"disabled": false,
|
10829
|
-
"document": "模板的H5预览链接,有效期5分钟。\n可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。\n
|
10830
|
-
"example": "
|
10829
|
+
"document": "模板的H5预览链接,有效期5分钟。\n可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。\n注意:此字段可能返回 null,表示取不到有效值。",
|
10830
|
+
"example": "https://embed.beta.qian.tencent.cn/document-url-preview?channel=PROXYCHANNEL&scene=SINGLEPAGE&code=yDSxNUUckptbbq64UEly7FaCkhsBlSLj&codeType=QUICK&businessType=TEMPLATE&businessId=yDSLVUUckpo3pub6UE5dPdv8pkDsrbEn&channel=PROXYCHANNEL",
|
10831
10831
|
"member": "string",
|
10832
10832
|
"name": "PreviewUrl",
|
10833
10833
|
"output_required": true,
|
@@ -10847,7 +10847,7 @@
|
|
10847
10847
|
{
|
10848
10848
|
"disabled": false,
|
10849
10849
|
"document": "本模板关联的第三方应用平台企业模板ID",
|
10850
|
-
"example": "
|
10850
|
+
"example": "yDSLKUUckpoqcjljUyzyvt7xDAq3564r",
|
10851
10851
|
"member": "string",
|
10852
10852
|
"name": "ChannelTemplateId",
|
10853
10853
|
"output_required": true,
|
@@ -10857,7 +10857,7 @@
|
|
10857
10857
|
{
|
10858
10858
|
"disabled": false,
|
10859
10859
|
"document": "本模板关联的三方应用平台平台企业模板名称\n注意:此字段可能返回 null,表示取不到有效值。",
|
10860
|
-
"example": "
|
10860
|
+
"example": "西红柿采购模板",
|
10861
10861
|
"member": "string",
|
10862
10862
|
"name": "ChannelTemplateName",
|
10863
10863
|
"output_required": true,
|
@@ -10867,7 +10867,7 @@
|
|
10867
10867
|
{
|
10868
10868
|
"disabled": false,
|
10869
10869
|
"document": "0-需要子客企业手动领取平台企业的模板(默认); \n1-平台自动设置子客模板\n注意:此字段可能返回 null,表示取不到有效值。",
|
10870
|
-
"example": "
|
10870
|
+
"example": "1",
|
10871
10871
|
"member": "int64",
|
10872
10872
|
"name": "ChannelAutoSave",
|
10873
10873
|
"output_required": true,
|
@@ -10876,8 +10876,8 @@
|
|
10876
10876
|
},
|
10877
10877
|
{
|
10878
10878
|
"disabled": false,
|
10879
|
-
"document": "
|
10880
|
-
"example": "
|
10879
|
+
"document": "模板版本,由全数字字符组成。\n默认为空,模板版本号由日期和序号组成,初始版本为yyyyMMdd001,yyyyMMdd002表示第二个版本,以此类推。\n注意:此字段可能返回 null,表示取不到有效值。",
|
10880
|
+
"example": "20231106004",
|
10881
10881
|
"member": "string",
|
10882
10882
|
"name": "TemplateVersion",
|
10883
10883
|
"output_required": true,
|
@@ -10886,8 +10886,8 @@
|
|
10886
10886
|
},
|
10887
10887
|
{
|
10888
10888
|
"disabled": false,
|
10889
|
-
"document": "
|
10890
|
-
"example": "
|
10889
|
+
"document": "模板可用状态的取值通常为以下两种:\n\n<ul><li>1:启用(默认),表示模板处于启用状态,可以被用户正常使用。</li>\n<li>2:停用,表示模板处于停用状态,禁止用户使用该模板。</li></ul>\n注意:此字段可能返回 null,表示取不到有效值。",
|
10890
|
+
"example": "1",
|
10891
10891
|
"member": "int64",
|
10892
10892
|
"name": "Available",
|
10893
10893
|
"output_required": true,
|
@@ -838,13 +838,13 @@
|
|
838
838
|
{
|
839
839
|
"document": "指定查询条件为TemplateId, 只返回此模板的信息",
|
840
840
|
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTemplates\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDwhxUUckp3gl8j5UuFX33LSNozpRsbi\",\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"ProxyAppId\": \"\"\n },\n \"TemplateIds\": [\n \"yDSLVUUckpo3pub6UE5dPdv8pkDsrbEn\"\n ]\n}",
|
841
|
-
"output": "{\n \"Response\": {\n \"Templates\": [\n {\n \"TemplateId\": \"yDSLVUUckpo3pub6UE5dPdv8pkDsrbEn\",\n \"TemplateName\": \"西红柿买卖合同模板\",\n \"Description\": \"南山农批西红柿买卖合同模板\",\n \"Components\": [],\n \"Recipients\": [\n {\n \"RecipientId\": \"yDSLVUUckpo3nocjUEnf33ki7GtMQC2L\",\n \"RecipientType\": \"INDIVIDUAL\",\n \"Description\": \"\",\n \"RoleName\": \"买房-自然人\",\n \"RequireValidation\": false,\n \"RequireSign\": false,\n \"SignType\": 0,\n \"RoutingOrder\": -1,\n \"IsPromoter\": false\n },\n {\n \"RecipientId\": \"yDSLVUUckpo3noc8UEnf33kxKp7Waeq1\",\n \"RecipientType\": \"ENTERPRISE\",\n \"Description\": \"\",\n \"RoleName\": \"卖方-菜市场\",\n \"RequireValidation\": false,\n \"RequireSign\": false,\n \"SignType\": 0,\n \"RoutingOrder\": -1,\n \"IsPromoter\": false\n }\n ],\n \"SignComponents\": [\n {\n \"ComponentId\": \"ComponentId_2\",\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentName\": \"企业印章\",\n \"ComponentRequired\": true,\n \"ComponentRecipientId\": \"yDSLVUUckpo3noc8UEnf33kxKp7Waeq1\",\n \"FileIndex\": 0,\n \"GenerateMode\": \"\",\n \"ComponentWidth\": 119,\n \"ComponentHeight\": 119,\n \"ComponentPage\": 1,\n \"ComponentPosX\": 32.640625,\n \"ComponentPosY\": 0,\n \"ComponentExtra\": \"{\\\"Date\\\":true,\\\"isAfterCut\\\":false,\\\"PageRanges\\\":[]}\",\n \"ComponentValue\": \"\",\n \"ComponentDateFontSize\": 0,\n \"DocumentId\": \"\",\n \"ComponentDescription\": \"\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"ChannelComponentId\": \"\",\n \"KeywordOrder\": \"\",\n \"KeywordPage\": 0,\n \"RelativeLocation\": \"\",\n \"KeywordIndexes\": [],\n \"Placeholder\": \"\"\n },\n {\n \"ComponentId\": \"ComponentId_5\",\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentName\": \"个人签名/印章\",\n \"ComponentRequired\": true,\n \"ComponentRecipientId\": \"yDSLVUUckpo3nocjUEnf33ki7GtMQC2L\",\n \"FileIndex\": 0,\n \"GenerateMode\": \"\",\n \"ComponentWidth\": 119,\n \"ComponentHeight\": 43,\n \"ComponentPage\": 1,\n \"ComponentPosX\": 397.640625,\n \"ComponentPosY\": 14,\n \"ComponentExtra\": \"{\\\"Date\\\":true,\\\"isAfterCut\\\":false}\",\n \"ComponentValue\": \"\",\n \"ComponentDateFontSize\": 0,\n \"DocumentId\": \"\",\n \"ComponentDescription\": \"\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"ChannelComponentId\": \"\",\n \"KeywordOrder\": \"\",\n \"KeywordPage\": 0,\n \"RelativeLocation\": \"\",\n \"KeywordIndexes\": [],\n \"Placeholder\": \"\"\n },\n {\n \"ComponentId\": \"ComponentId_6\",\n \"ComponentType\": \"SIGN_DATE\",\n \"ComponentName\": \"签署日期1\",\n \"ComponentRequired\": true,\n \"ComponentRecipientId\": \"yDSLVUUckpo3nocjUEnf33ki7GtMQC2L\",\n \"FileIndex\": 0,\n \"GenerateMode\": \"\",\n \"ComponentWidth\": 119,\n \"ComponentHeight\": 20,\n \"ComponentPage\": 1,\n \"ComponentPosX\": 397.640625,\n \"ComponentPosY\": 57,\n \"ComponentExtra\": \"{\\\"Format\\\":\\\"yyyy年m月d日\\\",\\\"Gaps\\\":\\\"2,2\\\",\\\"FontSize\\\":12,\\\"FontAlign\\\":\\\"Center\\\",\\\"Font\\\":\\\"黑体\\\",\\\"isAfterCut\\\":false}\",\n \"ComponentValue\": \"\",\n \"ComponentDateFontSize\": 0,\n \"DocumentId\": \"\",\n \"ComponentDescription\": \"\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"ChannelComponentId\": \"\",\n \"KeywordOrder\": \"\",\n \"KeywordPage\": 0,\n \"RelativeLocation\": \"\",\n \"KeywordIndexes\": [],\n \"Placeholder\": \"\"\n },\n {\n \"ComponentId\": \"ComponentId_3\",\n \"ComponentType\": \"SIGN_DATE\",\n \"ComponentName\": \"签署日期\",\n \"ComponentRequired\": true,\n \"ComponentRecipientId\": \"yDSLVUUckpo3noc8UEnf33kxKp7Waeq1\",\n \"FileIndex\": 0,\n \"GenerateMode\": \"\",\n \"ComponentWidth\": 119,\n \"ComponentHeight\": 20,\n \"ComponentPage\": 1,\n \"ComponentPosX\": 32.640625,\n \"ComponentPosY\": 119,\n \"ComponentExtra\": \"{\\\"Format\\\":\\\"yyyy年m月d日\\\",\\\"Gaps\\\":\\\"2,2\\\",\\\"FontSize\\\":12,\\\"FontAlign\\\":\\\"Center\\\",\\\"Font\\\":\\\"黑体\\\",\\\"isAfterCut\\\":false}\",\n \"ComponentValue\": \"\",\n \"ComponentDateFontSize\": 0,\n \"DocumentId\": \"\",\n \"ComponentDescription\": \"\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"ChannelComponentId\": \"\",\n \"KeywordOrder\": \"\",\n \"KeywordPage\": 0,\n \"RelativeLocation\": \"\",\n \"KeywordIndexes\": [],\n \"Placeholder\": \"\"\n }\n ],\n \"TemplateType\": 3,\n \"IsPromoter\": false,\n \"Creator\": \"张三\",\n \"CreatedOn\": 1699259970,\n \"PreviewUrl\": \"\",\n \"PdfUrl\": \"\",\n \"ChannelTemplateId\": \"\",\n \"ChannelTemplateName\": \"\",\n \"ChannelAutoSave\": 0,\n \"TemplateVersion\": \"20231106002\",\n \"Available\": 1\n }\n ],\n \"TotalCount\": 1,\n \"Limit\": 0,\n \"Offset\": 0,\n \"RequestId\": \"072c42c3-8ec2-43f3-b872-bc28594b0597\"\n }\n}",
|
841
|
+
"output": "{\n \"Response\": {\n \"Templates\": [\n {\n \"TemplateId\": \"yDSLVUUckpo3pub6UE5dPdv8pkDsrbEn\",\n \"TemplateName\": \"西红柿买卖合同模板\",\n \"Description\": \"南山农批西红柿买卖合同模板\",\n \"Components\": [],\n \"Recipients\": [\n {\n \"RecipientId\": \"yDSLVUUckpo3nocjUEnf33ki7GtMQC2L\",\n \"RecipientType\": \"INDIVIDUAL\",\n \"Description\": \"\",\n \"RoleName\": \"买房-自然人\",\n \"RequireValidation\": false,\n \"RequireSign\": false,\n \"SignType\": 0,\n \"RoutingOrder\": -1,\n \"IsPromoter\": false,\n \"ApproverVerifyTypes\": [\n 1\n ],\n \"ApproverSignTypes\": [\n 1,\n 2\n ]\n },\n {\n \"RecipientId\": \"yDSLVUUckpo3noc8UEnf33kxKp7Waeq1\",\n \"RecipientType\": \"ENTERPRISE\",\n \"Description\": \"\",\n \"RoleName\": \"卖方-菜市场\",\n \"RequireValidation\": false,\n \"RequireSign\": false,\n \"SignType\": 0,\n \"RoutingOrder\": -1,\n \"IsPromoter\": false,\n \"ApproverVerifyTypes\": [\n 1\n ],\n \"ApproverSignTypes\": [\n 1,\n 2\n ]\n }\n ],\n \"SignComponents\": [\n {\n \"ComponentId\": \"ComponentId_2\",\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentName\": \"企业印章\",\n \"ComponentRequired\": true,\n \"ComponentRecipientId\": \"yDSLVUUckpo3noc8UEnf33kxKp7Waeq1\",\n \"FileIndex\": 0,\n \"GenerateMode\": \"\",\n \"ComponentWidth\": 119,\n \"ComponentHeight\": 119,\n \"ComponentPage\": 1,\n \"ComponentPosX\": 32.640625,\n \"ComponentPosY\": 0,\n \"ComponentExtra\": \"{\\\"Date\\\":true,\\\"isAfterCut\\\":false,\\\"PageRanges\\\":[]}\",\n \"ComponentValue\": \"\",\n \"ComponentDateFontSize\": 0,\n \"DocumentId\": \"\",\n \"ComponentDescription\": \"\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"ChannelComponentId\": \"\",\n \"KeywordOrder\": \"\",\n \"KeywordPage\": 0,\n \"RelativeLocation\": \"\",\n \"KeywordIndexes\": [],\n \"Placeholder\": \"\"\n },\n {\n \"ComponentId\": \"ComponentId_5\",\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentName\": \"个人签名/印章\",\n \"ComponentRequired\": true,\n \"ComponentRecipientId\": \"yDSLVUUckpo3nocjUEnf33ki7GtMQC2L\",\n \"FileIndex\": 0,\n \"GenerateMode\": \"\",\n \"ComponentWidth\": 119,\n \"ComponentHeight\": 43,\n \"ComponentPage\": 1,\n \"ComponentPosX\": 397.640625,\n \"ComponentPosY\": 14,\n \"ComponentExtra\": \"{\\\"Date\\\":true,\\\"isAfterCut\\\":false}\",\n \"ComponentValue\": \"\",\n \"ComponentDateFontSize\": 0,\n \"DocumentId\": \"\",\n \"ComponentDescription\": \"\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"ChannelComponentId\": \"\",\n \"KeywordOrder\": \"\",\n \"KeywordPage\": 0,\n \"RelativeLocation\": \"\",\n \"KeywordIndexes\": [],\n \"Placeholder\": \"\"\n },\n {\n \"ComponentId\": \"ComponentId_6\",\n \"ComponentType\": \"SIGN_DATE\",\n \"ComponentName\": \"签署日期1\",\n \"ComponentRequired\": true,\n \"ComponentRecipientId\": \"yDSLVUUckpo3nocjUEnf33ki7GtMQC2L\",\n \"FileIndex\": 0,\n \"GenerateMode\": \"\",\n \"ComponentWidth\": 119,\n \"ComponentHeight\": 20,\n \"ComponentPage\": 1,\n \"ComponentPosX\": 397.640625,\n \"ComponentPosY\": 57,\n \"ComponentExtra\": \"{\\\"Format\\\":\\\"yyyy年m月d日\\\",\\\"Gaps\\\":\\\"2,2\\\",\\\"FontSize\\\":12,\\\"FontAlign\\\":\\\"Center\\\",\\\"Font\\\":\\\"黑体\\\",\\\"isAfterCut\\\":false}\",\n \"ComponentValue\": \"\",\n \"ComponentDateFontSize\": 0,\n \"DocumentId\": \"\",\n \"ComponentDescription\": \"\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"ChannelComponentId\": \"\",\n \"KeywordOrder\": \"\",\n \"KeywordPage\": 0,\n \"RelativeLocation\": \"\",\n \"KeywordIndexes\": [],\n \"Placeholder\": \"\"\n },\n {\n \"ComponentId\": \"ComponentId_3\",\n \"ComponentType\": \"SIGN_DATE\",\n \"ComponentName\": \"签署日期\",\n \"ComponentRequired\": true,\n \"ComponentRecipientId\": \"yDSLVUUckpo3noc8UEnf33kxKp7Waeq1\",\n \"FileIndex\": 0,\n \"GenerateMode\": \"\",\n \"ComponentWidth\": 119,\n \"ComponentHeight\": 20,\n \"ComponentPage\": 1,\n \"ComponentPosX\": 32.640625,\n \"ComponentPosY\": 119,\n \"ComponentExtra\": \"{\\\"Format\\\":\\\"yyyy年m月d日\\\",\\\"Gaps\\\":\\\"2,2\\\",\\\"FontSize\\\":12,\\\"FontAlign\\\":\\\"Center\\\",\\\"Font\\\":\\\"黑体\\\",\\\"isAfterCut\\\":false}\",\n \"ComponentValue\": \"\",\n \"ComponentDateFontSize\": 0,\n \"DocumentId\": \"\",\n \"ComponentDescription\": \"\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"ChannelComponentId\": \"\",\n \"KeywordOrder\": \"\",\n \"KeywordPage\": 0,\n \"RelativeLocation\": \"\",\n \"KeywordIndexes\": [],\n \"Placeholder\": \"\"\n }\n ],\n \"TemplateType\": 3,\n \"IsPromoter\": false,\n \"Creator\": \"张三\",\n \"CreatedOn\": 1699259970,\n \"PreviewUrl\": \"\",\n \"PdfUrl\": \"\",\n \"ChannelTemplateId\": \"\",\n \"ChannelTemplateName\": \"\",\n \"ChannelAutoSave\": 0,\n \"TemplateVersion\": \"20231106002\",\n \"Available\": 1\n }\n ],\n \"TotalCount\": 1,\n \"Limit\": 0,\n \"Offset\": 0,\n \"RequestId\": \"072c42c3-8ec2-43f3-b872-bc28594b0597\"\n }\n}",
|
842
842
|
"title": "模板查询接口-指定模板Id查询模板信息"
|
843
843
|
},
|
844
844
|
{
|
845
845
|
"document": "1.指定查询条件为TemplateName\n2.指定QueryAllComponents为true,返回所有参与方(创建方+签署方)的填写控件列表Components",
|
846
846
|
"input": "POST / HTTP/1.1\nHost: essbasic.tencentcloudapi.com\nContent-Type: application/json\nX-TC-Action: DescribeTemplates\n<公共请求参数>\n\n{\n \"Agent\": {\n \"AppId\": \"yDwhxUUckp3gl8j5UuFX33LSNozpRsbi\",\n \"ProxyOrganizationOpenId\": \"org_dianziqian\",\n \"ProxyOperator\": {\n \"OpenId\": \"n9527\"\n },\n \"ProxyAppId\": \"\"\n },\n \"TemplateName\": \"西红柿\",\n \"QueryAllComponents\": true\n}",
|
847
|
-
"output": "{\n \"Response\": {\n \"Templates\": [\n {\n \"TemplateId\": \"yDSLVUUckpo3pub6UE5dPdv8pkDsrbEn\",\n \"TemplateName\": \"西红柿买卖合同模板\",\n \"Description\": \"南山农批西红柿买卖合同模板\",\n \"Components\": [\n {\n \"ComponentId\": \"ComponentId_11\",\n \"ComponentType\": \"TEXT\",\n \"ComponentName\": \"西红柿的价格\",\n \"ComponentRequired\": true,\n \"ComponentRecipientId\": \"yDSLVUUckpo3nwi1UEnf33kBMNXjdB2c\",\n \"FileIndex\": 0,\n \"GenerateMode\": \"\",\n \"ComponentWidth\": 144,\n \"ComponentHeight\": 20,\n \"ComponentPage\": 1,\n \"ComponentPosX\": 336.640625,\n \"ComponentPosY\": 205,\n \"ComponentExtra\": \"{\\\"FontSize\\\":12,\\\"FontAlign\\\":\\\"Left\\\",\\\"Font\\\":\\\"黑体\\\",\\\"SubType\\\":\\\"TEXT\\\",\\\"MaxLength\\\":12}\",\n \"ComponentValue\": \"\",\n \"ComponentDateFontSize\": 0,\n \"DocumentId\": \"\",\n \"ComponentDescription\": \"\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"ChannelComponentId\": \"\",\n \"KeywordOrder\": \"\",\n \"KeywordPage\": 0,\n \"RelativeLocation\": \"\",\n \"KeywordIndexes\": [],\n \"Placeholder\": \"\"\n },\n {\n \"ComponentId\": \"ComponentId_12\",\n \"ComponentType\": \"TEXT\",\n \"ComponentName\": \"西红柿的交接时间\",\n \"ComponentRequired\": true,\n \"ComponentRecipientId\": \"yDSLVUUckpo3nwi1UEnf33kBMNXjdB2c\",\n \"FileIndex\": 0,\n \"GenerateMode\": \"\",\n \"ComponentWidth\": 144,\n \"ComponentHeight\": 20,\n \"ComponentPage\": 1,\n \"ComponentPosX\": 341.640625,\n \"ComponentPosY\": 270,\n \"ComponentExtra\": \"{\\\"FontSize\\\":12,\\\"FontAlign\\\":\\\"Left\\\",\\\"Font\\\":\\\"黑体\\\",\\\"SubType\\\":\\\"TEXT\\\",\\\"MaxLength\\\":12}\",\n \"ComponentValue\": \"\",\n \"ComponentDateFontSize\": 0,\n \"DocumentId\": \"\",\n \"ComponentDescription\": \"\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"ChannelComponentId\": \"\",\n \"KeywordOrder\": \"\",\n \"KeywordPage\": 0,\n \"RelativeLocation\": \"\",\n \"KeywordIndexes\": [],\n \"Placeholder\": \"\"\n }\n ],\n \"Recipients\": [\n {\n \"RecipientId\": \"yDSLVUUckpo3nwi3UEnf33kxdJyaybFb\",\n \"RecipientType\": \"INDIVIDUAL\",\n \"Description\": \"\",\n \"RoleName\": \"买房-自然人\",\n \"RequireValidation\": false,\n \"RequireSign\": false,\n \"SignType\": 0,\n \"RoutingOrder\": -1,\n \"IsPromoter\": false\n },\n {\n \"RecipientId\": \"yDSLVUUckpo3nwi1UEnf33kBMNXjdB2c\",\n \"RecipientType\": \"ENTERPRISE\",\n \"Description\": \"\",\n \"RoleName\": \"卖方-菜市场\",\n \"RequireValidation\": false,\n \"RequireSign\": false,\n \"SignType\": 0,\n \"RoutingOrder\": -1,\n \"IsPromoter\": false\n }\n ],\n \"SignComponents\": [\n {\n \"ComponentId\": \"ComponentId_2\",\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentName\": \"企业印章\",\n \"ComponentRequired\": true,\n \"ComponentRecipientId\": \"yDSLVUUckpo3nwi1UEnf33kBMNXjdB2c\",\n \"FileIndex\": 0,\n \"GenerateMode\": \"\",\n \"ComponentWidth\": 119,\n \"ComponentHeight\": 119,\n \"ComponentPage\": 1,\n \"ComponentPosX\": 32.640625,\n \"ComponentPosY\": 0,\n \"ComponentExtra\": \"{\\\"Date\\\":true,\\\"isAfterCut\\\":false,\\\"PageRanges\\\":[]}\",\n \"ComponentValue\": \"\",\n \"ComponentDateFontSize\": 0,\n \"DocumentId\": \"\",\n \"ComponentDescription\": \"\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"ChannelComponentId\": \"\",\n \"KeywordOrder\": \"\",\n \"KeywordPage\": 0,\n \"RelativeLocation\": \"\",\n \"KeywordIndexes\": [],\n \"Placeholder\": \"\"\n },\n {\n \"ComponentId\": \"ComponentId_5\",\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentName\": \"个人签名/印章\",\n \"ComponentRequired\": true,\n \"ComponentRecipientId\": \"yDSLVUUckpo3nwi3UEnf33kxdJyaybFb\",\n \"FileIndex\": 0,\n \"GenerateMode\": \"\",\n \"ComponentWidth\": 119,\n \"ComponentHeight\": 43,\n \"ComponentPage\": 1,\n \"ComponentPosX\": 397.640625,\n \"ComponentPosY\": 14,\n \"ComponentExtra\": \"{\\\"Date\\\":true,\\\"isAfterCut\\\":false}\",\n \"ComponentValue\": \"\",\n \"ComponentDateFontSize\": 0,\n \"DocumentId\": \"\",\n \"ComponentDescription\": \"\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"ChannelComponentId\": \"\",\n \"KeywordOrder\": \"\",\n \"KeywordPage\": 0,\n \"RelativeLocation\": \"\",\n \"KeywordIndexes\": [],\n \"Placeholder\": \"\"\n },\n {\n \"ComponentId\": \"ComponentId_6\",\n \"ComponentType\": \"SIGN_DATE\",\n \"ComponentName\": \"签署日期1\",\n \"ComponentRequired\": true,\n \"ComponentRecipientId\": \"yDSLVUUckpo3nwi3UEnf33kxdJyaybFb\",\n \"FileIndex\": 0,\n \"GenerateMode\": \"\",\n \"ComponentWidth\": 119,\n \"ComponentHeight\": 20,\n \"ComponentPage\": 1,\n \"ComponentPosX\": 397.640625,\n \"ComponentPosY\": 57,\n \"ComponentExtra\": \"{\\\"Format\\\":\\\"yyyy年m月d日\\\",\\\"Gaps\\\":\\\"2,2\\\",\\\"FontSize\\\":12,\\\"FontAlign\\\":\\\"Center\\\",\\\"Font\\\":\\\"黑体\\\",\\\"isAfterCut\\\":false,\\\"PageRanges\\\":[]}\",\n \"ComponentValue\": \"\",\n \"ComponentDateFontSize\": 0,\n \"DocumentId\": \"\",\n \"ComponentDescription\": \"\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"ChannelComponentId\": \"\",\n \"KeywordOrder\": \"\",\n \"KeywordPage\": 0,\n \"RelativeLocation\": \"\",\n \"KeywordIndexes\": [],\n \"Placeholder\": \"\"\n },\n {\n \"ComponentId\": \"ComponentId_3\",\n \"ComponentType\": \"SIGN_DATE\",\n \"ComponentName\": \"签署日期\",\n \"ComponentRequired\": true,\n \"ComponentRecipientId\": \"yDSLVUUckpo3nwi1UEnf33kBMNXjdB2c\",\n \"FileIndex\": 0,\n \"GenerateMode\": \"\",\n \"ComponentWidth\": 119,\n \"ComponentHeight\": 20,\n \"ComponentPage\": 1,\n \"ComponentPosX\": 32.640625,\n \"ComponentPosY\": 119,\n \"ComponentExtra\": \"{\\\"Format\\\":\\\"yyyy年m月d日\\\",\\\"Gaps\\\":\\\"2,2\\\",\\\"FontSize\\\":12,\\\"FontAlign\\\":\\\"Center\\\",\\\"Font\\\":\\\"黑体\\\",\\\"isAfterCut\\\":false,\\\"PageRanges\\\":[]}\",\n \"ComponentValue\": \"\",\n \"ComponentDateFontSize\": 0,\n \"DocumentId\": \"\",\n \"ComponentDescription\": \"\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"ChannelComponentId\": \"\",\n \"KeywordOrder\": \"\",\n \"KeywordPage\": 0,\n \"RelativeLocation\": \"\",\n \"KeywordIndexes\": [],\n \"Placeholder\": \"\"\n }\n ],\n \"TemplateType\": 3,\n \"IsPromoter\": false,\n \"Creator\": \"张三\",\n \"CreatedOn\": 1699259970,\n \"PreviewUrl\": \"\",\n \"PdfUrl\": \"\",\n \"ChannelTemplateId\": \"\",\n \"ChannelTemplateName\": \"\",\n \"ChannelAutoSave\": 0,\n \"TemplateVersion\": \"20231106004\",\n \"Available\": 1\n }\n ],\n \"TotalCount\": 1,\n \"Limit\": 20,\n \"Offset\": 0,\n \"RequestId\": \"8fb09e62-9642-44c8-992b-ddd6e5086293\"\n }\n}",
|
847
|
+
"output": "{\n \"Response\": {\n \"Templates\": [\n {\n \"TemplateId\": \"yDSLVUUckpo3pub6UE5dPdv8pkDsrbEn\",\n \"TemplateName\": \"西红柿买卖合同模板\",\n \"Description\": \"南山农批西红柿买卖合同模板\",\n \"Components\": [\n {\n \"ComponentId\": \"ComponentId_11\",\n \"ComponentType\": \"TEXT\",\n \"ComponentName\": \"西红柿的价格\",\n \"ComponentRequired\": true,\n \"ComponentRecipientId\": \"yDSLVUUckpo3nwi1UEnf33kBMNXjdB2c\",\n \"FileIndex\": 0,\n \"GenerateMode\": \"\",\n \"ComponentWidth\": 144,\n \"ComponentHeight\": 20,\n \"ComponentPage\": 1,\n \"ComponentPosX\": 336.640625,\n \"ComponentPosY\": 205,\n \"ComponentExtra\": \"{\\\"FontSize\\\":12,\\\"FontAlign\\\":\\\"Left\\\",\\\"Font\\\":\\\"黑体\\\",\\\"SubType\\\":\\\"TEXT\\\",\\\"MaxLength\\\":12}\",\n \"ComponentValue\": \"\",\n \"ComponentDateFontSize\": 0,\n \"DocumentId\": \"\",\n \"ComponentDescription\": \"\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"ChannelComponentId\": \"\",\n \"KeywordOrder\": \"\",\n \"KeywordPage\": 0,\n \"RelativeLocation\": \"\",\n \"KeywordIndexes\": [],\n \"Placeholder\": \"\"\n },\n {\n \"ComponentId\": \"ComponentId_12\",\n \"ComponentType\": \"TEXT\",\n \"ComponentName\": \"西红柿的交接时间\",\n \"ComponentRequired\": true,\n \"ComponentRecipientId\": \"yDSLVUUckpo3nwi1UEnf33kBMNXjdB2c\",\n \"FileIndex\": 0,\n \"GenerateMode\": \"\",\n \"ComponentWidth\": 144,\n \"ComponentHeight\": 20,\n \"ComponentPage\": 1,\n \"ComponentPosX\": 341.640625,\n \"ComponentPosY\": 270,\n \"ComponentExtra\": \"{\\\"FontSize\\\":12,\\\"FontAlign\\\":\\\"Left\\\",\\\"Font\\\":\\\"黑体\\\",\\\"SubType\\\":\\\"TEXT\\\",\\\"MaxLength\\\":12}\",\n \"ComponentValue\": \"\",\n \"ComponentDateFontSize\": 0,\n \"DocumentId\": \"\",\n \"ComponentDescription\": \"\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"ChannelComponentId\": \"\",\n \"KeywordOrder\": \"\",\n \"KeywordPage\": 0,\n \"RelativeLocation\": \"\",\n \"KeywordIndexes\": [],\n \"Placeholder\": \"\"\n }\n ],\n \"Recipients\": [\n {\n \"RecipientId\": \"yDSLVUUckpo3nwi3UEnf33kxdJyaybFb\",\n \"RecipientType\": \"INDIVIDUAL\",\n \"Description\": \"\",\n \"RoleName\": \"买房-自然人\",\n \"RequireValidation\": false,\n \"RequireSign\": false,\n \"SignType\": 0,\n \"RoutingOrder\": -1,\n \"IsPromoter\": false,\n \"ApproverVerifyTypes\": [\n 1\n ],\n \"ApproverSignTypes\": [\n 1,\n 2\n ]\n },\n {\n \"RecipientId\": \"yDSLVUUckpo3nwi1UEnf33kBMNXjdB2c\",\n \"RecipientType\": \"ENTERPRISE\",\n \"Description\": \"\",\n \"RoleName\": \"卖方-菜市场\",\n \"RequireValidation\": false,\n \"RequireSign\": false,\n \"SignType\": 0,\n \"RoutingOrder\": -1,\n \"IsPromoter\": false,\n \"ApproverVerifyTypes\": [\n 1\n ],\n \"ApproverSignTypes\": [\n 1,\n 2\n ]\n }\n ],\n \"SignComponents\": [\n {\n \"ComponentId\": \"ComponentId_2\",\n \"ComponentType\": \"SIGN_SEAL\",\n \"ComponentName\": \"企业印章\",\n \"ComponentRequired\": true,\n \"ComponentRecipientId\": \"yDSLVUUckpo3nwi1UEnf33kBMNXjdB2c\",\n \"FileIndex\": 0,\n \"GenerateMode\": \"\",\n \"ComponentWidth\": 119,\n \"ComponentHeight\": 119,\n \"ComponentPage\": 1,\n \"ComponentPosX\": 32.640625,\n \"ComponentPosY\": 0,\n \"ComponentExtra\": \"{\\\"Date\\\":true,\\\"isAfterCut\\\":false,\\\"PageRanges\\\":[]}\",\n \"ComponentValue\": \"\",\n \"ComponentDateFontSize\": 0,\n \"DocumentId\": \"\",\n \"ComponentDescription\": \"\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"ChannelComponentId\": \"\",\n \"KeywordOrder\": \"\",\n \"KeywordPage\": 0,\n \"RelativeLocation\": \"\",\n \"KeywordIndexes\": [],\n \"Placeholder\": \"\"\n },\n {\n \"ComponentId\": \"ComponentId_5\",\n \"ComponentType\": \"SIGN_SIGNATURE\",\n \"ComponentName\": \"个人签名/印章\",\n \"ComponentRequired\": true,\n \"ComponentRecipientId\": \"yDSLVUUckpo3nwi3UEnf33kxdJyaybFb\",\n \"FileIndex\": 0,\n \"GenerateMode\": \"\",\n \"ComponentWidth\": 119,\n \"ComponentHeight\": 43,\n \"ComponentPage\": 1,\n \"ComponentPosX\": 397.640625,\n \"ComponentPosY\": 14,\n \"ComponentExtra\": \"{\\\"Date\\\":true,\\\"isAfterCut\\\":false}\",\n \"ComponentValue\": \"\",\n \"ComponentDateFontSize\": 0,\n \"DocumentId\": \"\",\n \"ComponentDescription\": \"\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"ChannelComponentId\": \"\",\n \"KeywordOrder\": \"\",\n \"KeywordPage\": 0,\n \"RelativeLocation\": \"\",\n \"KeywordIndexes\": [],\n \"Placeholder\": \"\"\n },\n {\n \"ComponentId\": \"ComponentId_6\",\n \"ComponentType\": \"SIGN_DATE\",\n \"ComponentName\": \"签署日期1\",\n \"ComponentRequired\": true,\n \"ComponentRecipientId\": \"yDSLVUUckpo3nwi3UEnf33kxdJyaybFb\",\n \"FileIndex\": 0,\n \"GenerateMode\": \"\",\n \"ComponentWidth\": 119,\n \"ComponentHeight\": 20,\n \"ComponentPage\": 1,\n \"ComponentPosX\": 397.640625,\n \"ComponentPosY\": 57,\n \"ComponentExtra\": \"{\\\"Format\\\":\\\"yyyy年m月d日\\\",\\\"Gaps\\\":\\\"2,2\\\",\\\"FontSize\\\":12,\\\"FontAlign\\\":\\\"Center\\\",\\\"Font\\\":\\\"黑体\\\",\\\"isAfterCut\\\":false,\\\"PageRanges\\\":[]}\",\n \"ComponentValue\": \"\",\n \"ComponentDateFontSize\": 0,\n \"DocumentId\": \"\",\n \"ComponentDescription\": \"\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"ChannelComponentId\": \"\",\n \"KeywordOrder\": \"\",\n \"KeywordPage\": 0,\n \"RelativeLocation\": \"\",\n \"KeywordIndexes\": [],\n \"Placeholder\": \"\"\n },\n {\n \"ComponentId\": \"ComponentId_3\",\n \"ComponentType\": \"SIGN_DATE\",\n \"ComponentName\": \"签署日期\",\n \"ComponentRequired\": true,\n \"ComponentRecipientId\": \"yDSLVUUckpo3nwi1UEnf33kBMNXjdB2c\",\n \"FileIndex\": 0,\n \"GenerateMode\": \"\",\n \"ComponentWidth\": 119,\n \"ComponentHeight\": 20,\n \"ComponentPage\": 1,\n \"ComponentPosX\": 32.640625,\n \"ComponentPosY\": 119,\n \"ComponentExtra\": \"{\\\"Format\\\":\\\"yyyy年m月d日\\\",\\\"Gaps\\\":\\\"2,2\\\",\\\"FontSize\\\":12,\\\"FontAlign\\\":\\\"Center\\\",\\\"Font\\\":\\\"黑体\\\",\\\"isAfterCut\\\":false,\\\"PageRanges\\\":[]}\",\n \"ComponentValue\": \"\",\n \"ComponentDateFontSize\": 0,\n \"DocumentId\": \"\",\n \"ComponentDescription\": \"\",\n \"OffsetX\": 0,\n \"OffsetY\": 0,\n \"ChannelComponentId\": \"\",\n \"KeywordOrder\": \"\",\n \"KeywordPage\": 0,\n \"RelativeLocation\": \"\",\n \"KeywordIndexes\": [],\n \"Placeholder\": \"\"\n }\n ],\n \"TemplateType\": 3,\n \"IsPromoter\": false,\n \"Creator\": \"张三\",\n \"CreatedOn\": 1699259970,\n \"PreviewUrl\": \"\",\n \"PdfUrl\": \"\",\n \"ChannelTemplateId\": \"\",\n \"ChannelTemplateName\": \"\",\n \"ChannelAutoSave\": 0,\n \"TemplateVersion\": \"20231106004\",\n \"Available\": 1\n }\n ],\n \"TotalCount\": 1,\n \"Limit\": 20,\n \"Offset\": 0,\n \"RequestId\": \"8fb09e62-9642-44c8-992b-ddd6e5086293\"\n }\n}",
|
848
848
|
"title": "模板查询接口-模糊搜索模板名"
|
849
849
|
},
|
850
850
|
{
|
@@ -1942,7 +1942,7 @@
|
|
1942
1942
|
{
|
1943
1943
|
"disabled": false,
|
1944
1944
|
"document": "防火墙模板ID。",
|
1945
|
-
"example": "lhft-
|
1945
|
+
"example": "lhft-abcd1234",
|
1946
1946
|
"member": "string",
|
1947
1947
|
"name": "TemplateId",
|
1948
1948
|
"required": true,
|
@@ -2156,7 +2156,7 @@
|
|
2156
2156
|
{
|
2157
2157
|
"disabled": false,
|
2158
2158
|
"document": "当通过本接口来创建实例时会返回该参数,表示一个或多个实例ID。返回实例ID列表并不代表实例创建成功。\n\n可根据 DescribeInstances 接口查询返回的InstancesSet中对应实例的ID的状态来判断创建是否完成;如果实例状态由“启动中”变为“运行中”,则为创建成功。",
|
2159
|
-
"example": "
|
2159
|
+
"example": "[\"lhins-abcd1234\"]",
|
2160
2160
|
"member": "string",
|
2161
2161
|
"name": "InstanceIdSet",
|
2162
2162
|
"output_required": true,
|
@@ -8586,7 +8586,7 @@
|
|
8586
8586
|
{
|
8587
8587
|
"disabled": false,
|
8588
8588
|
"document": "重置后的规则ID列表。",
|
8589
|
-
"example": "
|
8589
|
+
"example": "[\"lhftr-abcde12345\"]",
|
8590
8590
|
"member": "string",
|
8591
8591
|
"name": "TemplateRuleIdSet",
|
8592
8592
|
"output_required": true,
|
@@ -8813,10 +8813,10 @@
|
|
8813
8813
|
{
|
8814
8814
|
"disabled": false,
|
8815
8815
|
"document": "Docker活动ID列表。",
|
8816
|
-
"example": "
|
8816
|
+
"example": "[\"lhda-9qq8eu91\"]",
|
8817
8817
|
"member": "string",
|
8818
8818
|
"name": "DockerActivitySet",
|
8819
|
-
"
|
8819
|
+
"output_required": true,
|
8820
8820
|
"type": "list",
|
8821
8821
|
"value_allowed_null": false
|
8822
8822
|
},
|